Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/)
Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
1.1.01.3.18Welcome to the CELITECH API documentation! Useful links: Homepage | Support email | Blog
This SDK is compatible with the following versions: Python >= 3.7
To get started with the SDK, we recommend installing using pip:
pip install celitech-sdk
The Celitech API uses OAuth for authentication.
You need to provide the OAuth parameters when initializing the SDK.
sdk = Celitech(
client_id="CLIENT_ID",
client_secret="CLIENT_SECRET"
)
If you need to set or update the OAuth parameters after the SDK initialization, you can use:
sdk.set_client_id("CLIENT_ID")
sdk.set_client_secret("CLIENT_SECRET")
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.
You can set a custom timeout for the SDK's HTTP requests as follows:
from celitech import Celitech
sdk = Celitech(timeout=10000)
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
from celitech import Celitech
sdk = Celitech(
client_id="CLIENT_ID",
client_secret="CLIENT_SECRET"
)
result = sdk.destinations.list_destinations()
print(result)
The SDK provides various services to interact with the API.
| Name |
|---|
| o_auth |
| destinations |
| packages |
| purchases |
| e_sim |
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.
| Name | Description |
|---|---|
| GetAccessTokenRequest | |
| GetAccessTokenOkResponse | |
| ListDestinationsOkResponse | |
| ListPackagesOkResponse | |
| ListPurchasesOkResponse | |
| CreatePurchaseRequest | |
| CreatePurchaseOkResponse | |
| TopUpEsimRequest | |
| TopUpEsimOkResponse | |
| EditPurchaseRequest | |
| EditPurchaseOkResponse | |
| GetPurchaseConsumptionOkResponse | |
| GetEsimOkResponse | |
| GetEsimDeviceOkResponse | |
| GetEsimHistoryOkResponse | |
| GetEsimMacOkResponse |
This SDK is licensed under the MIT License.
See the LICENSE file for more details.
FAQs
Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/)
We found that celitech-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.