RESTful APIs

From Social ID Developers
(Difference between revisions)
Jump to: navigation, search
 
(4 intermediate revisions by one user not shown)
Line 1: Line 1:
 +
== Available APIs ==
 +
 
In this page you can explore all available APIs for the CoffeeBean Identity and Access Platform:
 
In this page you can explore all available APIs for the CoffeeBean Identity and Access Platform:
  
 
* [[Authentication]]
 
* [[Authentication]]
 
* [[Errors]]
 
* [[Errors]]
* [[Social Login APIs]]
+
* [[Login & Management APIs]]
<!-- * [[Marketing Database APIs]] -->
+
 
* [[Push Notification APIs]]
 
* [[Push Notification APIs]]
* [[Campaign Engine APIs]]
+
* [[Automation Engine APIs]]
 
* [[Datastore APIs]]
 
* [[Datastore APIs]]
 
* [[OAuth APIs]]
 
* [[OAuth APIs]]
 
* [[Wi-Fi 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 ==
 
== Deprecated APIs ==

Latest revision as of 20:18, 12 January 2021

Contents

Available APIs

In this page you can explore all available APIs for the CoffeeBean Identity and Access Platform:

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

Resources

Postman.png

Deprecated APIs

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox