# README
Celitech Go SDK 1.0.5
Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
Versions
- API version:
1.1.0 - SDK version:
1.0.5
About the API
Welcome to the CELITECH API documentation! Useful links: Homepage | Support email | Blog
Table of Contents
Setup & Configuration
Supported Language Versions
This SDK is compatible with the following versions: Go >= 1.19.0
Authentication
OAuth Authentication
The Celitech API uses OAuth for authentication.
You need to provide the OAuth parameters when initializing the SDK.
If you need to set or update the OAuth parameters after the SDK initialization, you can use:
Environment Variables
These are the environment variables for the SDK:
| Name | Description |
|---|---|
| CLIENT_ID | Client ID parameter |
| CLIENT_SECRET | Client Secret parameter |
Environment variables are a way to configure your application outside the code. You can set these environment variables on the command line or use your project's existing tooling for managing environment variables.
If you are using a .env file, a template with the variable names is provided in the .env.example file located in the same directory as this README.
Services
The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
| Name |
|---|
| OAuthService |
| DestinationsService |
| PackagesService |
| PurchasesService |
| ESimService |
Response Wrappers
All services use response wrappers to provide a consistent interface to return the responses from the API.
The response wrapper itself is a generic struct that contains the response data and metadata.
Below are the response wrappers used in the SDK:
CelitechResponse[T]
This response wrapper is used to return the response data from the API. It contains the following fields:
| Name | Type | Description |
|---|---|---|
| Data | T | The body of the API response |
| Metadata | CelitechResponseMetadata | Status code and headers returned by the API |
CelitechError
This response wrapper is used to return an error. It contains the following fields:
| Name | Type | Description |
|---|---|---|
| Err | error | The error that occurred |
| Body | T | The body of the API response |
| Metadata | CelitechResponseMetadata | Status code and headers returned by the API |
CelitechResponseMetadata
This struct is shared by both response wrappers and contains the following fields:
| Name | Type | Description |
|---|---|---|
| Headers | map[string]string | A map containing the headers returned by the API |
| StatusCode | int | The status code returned by the API |
Models
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
License
This SDK is licensed under the MIT License.
See the LICENSE file for more details.