Addax
This API provides (User Management, Entity Manipulation, Short Message Service [only for Rwanda], Chat and Notofication) features.
45 subscribers
30 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Addax endpoints
| Method | Endpoint | Description |
|---|---|---|
| User | ||
| POST |
sign-up /user/sign-up |
This request is for sign up, after the sign up you have an admin's privilege. You must save your api_key somewhere cause it is going to be used for the rest of the requests. |
| POST |
login /user/login |
This request is for logging in. |
| POST |
Updatinguserprofile /user/profile/update |
This request is for updating the user profile. |
| POST |
Giveprivilegeonuserrole /user/create/privilege |
|
| POST |
Readingalluserprofile /user/profile/all |
This request is for reading all user profile. |
| GET |
Verifyusername /user/verify/username |
|
| POST |
Createuserrole /user/create/role |
|
| POST |
Registeruser /user/register |
This request is for registering a new user. You need to specify your API Key so that the user can be related to your account. |
| POST |
Readingtheuserprofile /user/profile/read |
This request is for loading the user profile for the passed user_emai. |
| POST |
Adduserprofile /user/profile/add |
This is the request to add a new user profile. |
| Entity | ||
| POST |
Deleteentityinstance /entity/instance/delete |
This request is for deleting an instance from an entity. |
| POST |
Destroyentity /entity/destroy |
This request is for destroying an existing entity. Once an entity is destroyed it does not appear in the list of entities and you can not (save or read) into/from the entity. |
| POST |
Readentityproperties /entity/read/properties |
This request is for reading entity properties. |
| POST |
Listentities /entity/list |
This request list all entities existing with respective details apart from the attribute. |
| POST |
Readwebfiltereddata /entity/read/data/filtered |
|
| POST |
Updateentityinstance /entity/instance/update |
This request is for updating a single instance in the database |
| POST |
Saveintoentity /entity/save |
This request is for saving data into an existing entity. |
| POST |
READWEBDATACopy /entity/web/data |
|
| POST |
ReadDataIdCopy /entity/read/data/id |
Reads web data by ID. |
| POST |
Readentitydata /entity/read/data |
This end point is for reading all data contained in the entity |
| POST |
createentity /entity/create |
This request is for creating an entity |
| SMS | ||
| POST |
ApproveSMSTopUpRequest /sms/top_up/approve |
This request us for approving sms top up request. |
| POST |
RequestSMSTopUp /sms/top_up |
This is the request to add new sms in stock. |
| POST |
ReadSMSTopUpRequests /sms/top_up/list |
This is the request to fetch the list of SMS top up. Only viewed by the super user. |
| POST |
SendBulkSMS /send/sms |
This request is for sending SMS to a list of number. |
| Chat | ||
| POST |
ReadconversationList /read/conversation/list |
Getting the list of user chat conversation. |
| POST |
Sendtextmessage /send/text |
This request is for sending a text message. |
| POST |
Readingduoconversation /read/conversation/duo |
|
| Notification | ||
| POST |
Sendemail /notification/notify/email |
Notify by email. |
| POST |
Configurenotification /configure/notification |
This request is for configuring notification. |
Addax pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|