Alef API Guide
This section contains links to our API Specifications and is aimed at users who have already gone through our Quickstart Guide and want to dig deeper. If you are new to using the Alef APIs, please refer back to Setup Guide.
Basics
The Alef APIs are REST/JSON based APIs. All API calls require that the caller is authenticated and uses the JWT token that is provided when logging in. Selected APIs still accept the provided API key as a valid token, however this method will be deprecated in the near future.
The APIs follow the generally accepted standards for REST APIs. Using GET, POST, PUT and DELETE commands to perform actions. Conforming to the standards, only POST and PUT commands will accept JSON bodies.
All APIs are documented using Swagger following the OpenAPI standards 3.0. To download the API specifications for use in Postman or other tools, add -json or -yaml to the urls.
Most values for the API calls are documented and provide reasonable defaults where possible. Please reach out to Alef Support (support@alefedge.com) if you have any questions or need guidance.
Authentication API
All users need to authenticate using the Authentication API. For this they need their username, password and the organization ID. Based on their profile they will get admin or user permissions.
The enforcement of the roles differs per API. Right now all APIs are available to admin roles. Future APIs will have more granular permissions.
Authentication API definitions
Account API
The Account APIs manage the user and sites in the customer account. All sites for the Mobile Networks need to be added here as part of the account. On the user side, admins and users can be added with their own login to consume the APIs.
Mobile Network API
The Mobile Network APIs manage the provisioning of the Mobile network. Here is your Mobile Network deployed and your RAN and Enterprise network connected. For Alef Enterprise Mobile Gateway customers, all settings to connect the Enterprise IAM to your Mobile Core are managed here too.
Mobile Network API definitions
SIM Management API
The SIM Management APIs provide the controls to upload your SIMs to Alef's platform. These APIs are only used when your SIMs are managed by Alef (so called classic mode).
When you use the Alef Enterprise Mobile Gateway, SIMs are managed in your own Enterprise IAM.
Reporting API
Refer to the Reporting Guide for more information