Go API client for localizely

Getting started

Localizely API is built on REST.
You can use this API for importing & exporting your localization files in order to automate the process with `curl` scripts or external CI tools.
Response is returned in JSON form even in case of error.

If you Authenticate with your API token on this page by clicking \"Authorize\" button, you can make API calls directly from here with \"Try it out\", and generate such `curl` examples.

API Authentication

Authenticate your account by sending your API token as a request header `X-Api-Token`.
The token can be found under My Profile page.
A user must have an Admin role in the project in order to access the project with his token.
API requests without authentication will fail.

Base url: `https://api.localizely.com`

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.2.1
• Package version: 1.0.2
• Generator version: 7.8.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import localizely "github.com/localizely/localizely-client-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value localizely.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), localizely.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value localizely.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), localizely.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using localizely.ContextOperationServerIndices and localizely.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), localizely.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), localizely.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.localizely.com

Class	Method	HTTP request	Description
BranchAPIAPI	CreateBranch	Post /v1/projects/{project_id}/branches/{branch}	Create a new branch
DownloadAPIAPI	GetLocalizationFile	Get /v1/projects/{project_id}/files/download	Download translations for a language in a specified file format
TranslationStatusAPIAPI	GetTranslationStatus	Get /v1/projects/{project_id}/status	Get Translation Status for the project
UploadAPIAPI	ImportLocalizationFile	Post /v1/projects/{project_id}/files/upload	Upload translations for a language

Documentation For Models

• ErrorDto
• ImportFileError
• InvalidImportFileErrorDto
• ProjectLocaleStatsDto
• ProjectStatusDto

Documentation For Authorization

Authentication schemes defined for the API:

API auth

• Type: API key
• API key parameter name: X-Api-Token
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-Api-Token and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		localizely.ContextAPIKeys,
		map[string]localizely.APIKey{
			"X-Api-Token": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author