Authentication
Ariana.luna (Talk | contribs) |
|||
| (15 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | All | + | All CoffeeBean Restful APIs make use of HTTP Basic for authentication. |
| − | Most APIs require authentication through the id/secret pair of | + | Most APIs require authentication through the id/secret pair of an Account or a Login App. |
| − | However, some APIs may be used without any authentication. An example is the login/info API, which only requires the | + | However, some APIs may be used without any authentication. An example is the login/info API, which only requires the Login App secret that can be found in the Login App settings. |
| − | = | + | = Account Authentication = |
| − | Each | + | Each Account has its own id/secret pair to access available APIs. |
| − | + | <b>This authentication must be used only on server applications (backend), never on client applications (frontend/mobile).</b> | |
| − | Once you log into the | + | == How to get Account id/secret pair? == |
| + | |||
| + | Once you log into the CoffeeBean Identity and Access Platform and set up an Account, access keys can be found in the following URL: | ||
https://app.socialidnow.com/marketing/apis | https://app.socialidnow.com/marketing/apis | ||
| Line 17: | Line 19: | ||
== Example == | == Example == | ||
| − | curl --user <api_id>:<api_secret> https://api.socialidnow.com/<path> | + | curl --user <api_id>:<api_secret> <nowiki>https://api.socialidnow.com/<path></nowiki> |
| + | |||
| + | = Login App Authentication = | ||
| + | |||
| + | Each Login App has its own id/secret pair to access available APIs. In those APIs the information created or retrieved will always be associated with the Login App used for authentication. | ||
| + | |||
| + | <b>This authentication must be used only on server applications (backend), never on client applications (frontend/mobile).</b> | ||
| + | |||
| + | == How to get Login App id/secret pair? == | ||
| + | |||
| + | Each Login App has an API area where access keys can be found: | ||
| + | |||
| + | [https://app.socialidnow.com/marketing/login/apps/login_app_id/apis https://app.socialidnow.com/marketing/login/apps/<login_app_id>/apis] | ||
| + | |||
| + | The App id is in the url (<login_app_id>). The App secret is the "API secret" key. | ||
| + | |||
| + | == Example == | ||
| + | |||
| + | curl --user <login_app_id>:<api_secret> <nowiki>https://api.socialidnow.com/<path></nowiki> | ||
| + | |||
| + | = Login App Client Authentication = | ||
| + | |||
| + | Each Login App has its own id/client secret pair to access available APIs. In those APIs the information created or retrieved will always be associated with the Login App used for authentication. | ||
| + | |||
| + | <b>This authentication may be used on server applications (backend) or client applications (frontend/mobile).</b> | ||
| + | |||
| + | == How to get Login App id/client secret pair? == | ||
| + | |||
| + | Each Login App has an API area where access keys can be found: | ||
| + | |||
| + | [https://app.socialidnow.com/marketing/login/apps/login_app_id/apis https://app.socialidnow.com/marketing/login/apps/<login_app_id>/apis] | ||
| + | |||
| + | The App id is in the url (<login_app_id>). The App client secret is the "API client secret" key. | ||
| + | |||
| + | == Example == | ||
| + | |||
| + | curl --user <login_app_id>:<api_client_secret> <nowiki>https://api.socialidnow.com/<path></nowiki> | ||
| + | |||
| + | = Wi-Fi API Authentication = | ||
| − | + | Each Wi-Fi Account has its own id/secret pair to access available APIs. | |
| − | + | <b>This authentication must be used only on server applications (backend), never on client applications (frontend/mobile).</b> | |
| − | == How to get | + | == How to get Wi-Fi API id/secret pair? == |
| − | + | Once you log into the CoffeeBean Wi-Fi platform and set up your account, API credentials can be found in the following URL: | |
| − | https:// | + | https://wifi.socialidnow.com/admin/account/edit |
== Example == | == Example == | ||
| − | curl --user < | + | curl --user <wifi_api_id>:<wifi_api_secret> <nowiki>https://wifi.socialidnow.com/<path></nowiki> |
Latest revision as of 16:46, 30 December 2021
All CoffeeBean Restful APIs make use of HTTP Basic for authentication.
Most APIs require authentication through the id/secret pair of an Account or a Login App.
However, some APIs may be used without any authentication. An example is the login/info API, which only requires the Login App secret that can be found in the Login App settings.
Contents |
Account Authentication
Each Account has its own id/secret pair to access available APIs.
This authentication must be used only on server applications (backend), never on client applications (frontend/mobile).
How to get Account id/secret pair?
Once you log into the CoffeeBean Identity and Access Platform and set up an Account, access keys can be found in the following URL:
https://app.socialidnow.com/marketing/apis
Example
curl --user <api_id>:<api_secret> https://api.socialidnow.com/<path>
Login App Authentication
Each Login App has its own id/secret pair to access available APIs. In those APIs the information created or retrieved will always be associated with the Login App used for authentication.
This authentication must be used only on server applications (backend), never on client applications (frontend/mobile).
How to get Login App id/secret pair?
Each Login App has an API area where access keys can be found:
https://app.socialidnow.com/marketing/login/apps/<login_app_id>/apis
The App id is in the url (<login_app_id>). The App secret is the "API secret" key.
Example
curl --user <login_app_id>:<api_secret> https://api.socialidnow.com/<path>
Login App Client Authentication
Each Login App has its own id/client secret pair to access available APIs. In those APIs the information created or retrieved will always be associated with the Login App used for authentication.
This authentication may be used on server applications (backend) or client applications (frontend/mobile).
How to get Login App id/client secret pair?
Each Login App has an API area where access keys can be found:
https://app.socialidnow.com/marketing/login/apps/<login_app_id>/apis
The App id is in the url (<login_app_id>). The App client secret is the "API client secret" key.
Example
curl --user <login_app_id>:<api_client_secret> https://api.socialidnow.com/<path>
Wi-Fi API Authentication
Each Wi-Fi Account has its own id/secret pair to access available APIs.
This authentication must be used only on server applications (backend), never on client applications (frontend/mobile).
How to get Wi-Fi API id/secret pair?
Once you log into the CoffeeBean Wi-Fi platform and set up your account, API credentials can be found in the following URL:
https://wifi.socialidnow.com/admin/account/edit
Example
curl --user <wifi_api_id>:<wifi_api_secret> https://wifi.socialidnow.com/<path>
