RESTful APIs
From Social ID Developers
(Difference between revisions)
Renato.neves (Talk | contribs) |
|||
(11 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | In this page you can explore all available APIs for the | + | == Available APIs == |
+ | |||
+ | In this page you can explore all available APIs for the CoffeeBean Identity and Access Platform: | ||
* [[Authentication]] | * [[Authentication]] | ||
* [[Errors]] | * [[Errors]] | ||
− | * [[ | + | * [[Login & Management APIs]] |
− | * [[ | + | * [[Group Management APIs]] |
− | * [[ | + | * [[RBAC Management APIs]] |
* [[Push Notification APIs]] | * [[Push Notification APIs]] | ||
− | * [[ | + | * [[Automation Engine APIs]] |
− | + | ||
* [[Datastore APIs]] | * [[Datastore APIs]] | ||
* [[OAuth APIs]] | * [[OAuth APIs]] | ||
+ | * [[Wi-Fi RESTful APIs|Wi-Fi APIs]] | ||
+ | |||
+ | == Environments == | ||
+ | |||
+ | By default, all APIs described on this documentation use the https://api.socialidnow.com host. You may need to change this host for the environment and region you are integrating with. For example, if you are developing an integration for a staging or sandbox environment, you need to replace any URL containing https://api.socialidnow.com to https://api-staging.socialidnow.com. | ||
+ | |||
+ | The list of available environments and regions are: | ||
+ | |||
+ | {| | ||
+ | ! style="text-align:left; width: 100px;"| Environment | ||
+ | ! style="text-align:left; width: 100px;"| Region | ||
+ | ! style="text-align:left; width: 300px;"| API host | ||
+ | |- | ||
+ | |production | ||
+ | |sa-east | ||
+ | |https://api.socialidnow.com | ||
+ | |- | ||
+ | |production | ||
+ | |eu-central | ||
+ | |https://api.eu-central.socialidnow.com | ||
+ | |- | ||
+ | |staging | ||
+ | |us-east | ||
+ | |https://api-staging.socialidnow.com | ||
+ | |} | ||
+ | |||
+ | == Resources == | ||
+ | |||
+ | [[File:Postman.png|150px]] | ||
+ | |||
+ | * [https://dev.socialidnow.com/downloads/postman/coffeebean-platform-apis.postman_collection.json Collection] | ||
+ | * [https://dev.socialidnow.com/downloads/postman/coffeebean-platform-apis.postman_environment.json Environment] | ||
+ | |||
+ | == Deprecated APIs == | ||
+ | |||
+ | * [[Campaign APIs]] | ||
+ | * [[Selfie APIs]] |
Latest revision as of 17:49, 24 July 2023
Contents |
Available APIs
In this page you can explore all available APIs for the CoffeeBean Identity and Access Platform:
- Authentication
- Errors
- Login & Management APIs
- Group Management APIs
- RBAC Management APIs
- Push Notification APIs
- Automation Engine APIs
- Datastore APIs
- OAuth APIs
- Wi-Fi APIs
Environments
By default, all APIs described on this documentation use the https://api.socialidnow.com host. You may need to change this host for the environment and region you are integrating with. For example, if you are developing an integration for a staging or sandbox environment, you need to replace any URL containing https://api.socialidnow.com to https://api-staging.socialidnow.com.
The list of available environments and regions are:
Environment | Region | API host |
---|---|---|
production | sa-east | https://api.socialidnow.com |
production | eu-central | https://api.eu-central.socialidnow.com |
staging | us-east | https://api-staging.socialidnow.com |