Authentication

From Social ID Developers
(Difference between revisions)
Jump to: navigation, search
 
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
A API Restful do Social-ID NOW utiliza autenticação HTTP Basic.
+
All CoffeeBean Restful APIs make use of HTTP Basic for authentication.
  
−
A maioria das APIs disponíveis requerem autenticação usando o id e secret de uma Conta de Marketing ou o id e secret de uma Aplicação de Social Login.
+
Most APIs require authentication through the id/secret pair of an Account or a Login App.  
  
−
Entretanto, algumas APIs pode ser utilizadas sem autenticação, como a API login/info, que exige apenas o Social Login secret disponibilizado na configuração de um Social Login.
+
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.
  
−
= Autenticação da Conta de Marketing =
+
= Account Authentication =
  
−
Cada Conta de Marketing possui um id e secret para acessar as APIs disponíveis.  
+
Each Account has its own id/secret pair to access available APIs.
  
−
== Como obter o id e secret da Conta de Marketing? ==
+
<b>This authentication must be used only on server applications (backend), never on client applications (frontend/mobile).</b>
  
−
Se você estiver logado no Social-ID NOW e com uma Conta de Marketing já criada, é possível obter as chaves de acesso na seguinte url:
+
== 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
  
−
== Exemplo ==
+
== Example ==
 +
 
 +
  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>
  
−
  curl --user <api_id>:<api_secret> https://api.socialidnow.com/<path>
+
= Wi-Fi API Authentication =
  
−
= Autenticação da Aplicação de Social Login =
+
Each Wi-Fi Account has its own id/secret pair to access available APIs.
  
−
Cada Aplicação de Social Login possui um id e secret para acessar as APIs que dependam desse tipo de autenticação. Nessas APIs as informações criadas e/ou obtidas serão sempre associadas à Aplicação de Social Login usada para autenticação.
+
<b>This authentication must be used only on server applications (backend), never on client applications (frontend/mobile).</b>
  
−
== Como obter o id e secret da Aplicação de Social Login? ==
+
== How to get Wi-Fi API id/secret pair? ==
  
−
Cada Aplicação de Social Login possui suas chaves de acesso que podem ser obtidas na área de API:
+
Once you log into the CoffeeBean Wi-Fi platform and set up your account, API credentials can be found in the following URL:
  
−
   https://app.socialidnow.com/marketing/login/apps/<login_app_id>/apis
+
   https://wifi.socialidnow.com/admin/account/edit
  
−
== Exemplo ==
+
== Example ==
  
−
   curl --user <login_app_id>:<api_secret> https://api.socialidnow.com/<path>
+
   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>
Retrieved from "https://dev.socialidnow.com/index.php?title=Authentication&oldid=3327"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox