Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Como utilizar as APIs do fluig Identity?


Solução

Para utilizar a API do Identity, você pode seguir como referência o Swagger.

01. Acessar https://[contexto].fluigidentity.com/rest/swagger-ui/index.html

02. Obter o Client Assertion (resultado no Response Body) passando o clientId de sua empresa:

Bloco de código
oauth2 > GET /rest/v2/oauth2/clients/{clientId}/assertion
Informações

Para obter o clientId, acesse como administrador o menu Configuração → aba Segurança → REST API v2 → ID do Cliente

03. Depois, é preciso obter o token passando como parâmetro o Client Assertion:

Bloco de código
oauth2 > POST /rest/v2/oauth2/auth

04. Após obter o token em Response Body > "access_token", copie o código e cole no campo superior da página "api_key" e pressione "Explore". Desta forma você poderá utilizar todos os endpoints da API do Identity.

Bloco de código
languagejs
titleExemplo de código
// Exemplo de código para obter as informações de uma empresa por ajax.

var clientId = '<CLIENT_ID>'; // Substituir '<CLIENT_ID>' pelo clientId da empresa
var companyId ='<COMPANY_ID>'; // Substituir '<COMPANY_ID>' pelo companyId da empresa
var domainUrl = 'https://<CONTEXT>.fluigidentity.com/'; //Substituir '<CONTEXT>' pelo contexto da empresa
var apiUrl = domainUrl + 'rest/v2/';

// Get client assertion
function getClientAssertion(clientId) {
  $.ajax({
    url:apiUrl + 'oauth2/clients/' + clientId + '/assertion',
    crossDomain:true // se necessário cross domain
  })
  .done(function(data){
    getAccessToken(data);
  })
  .fail(function(error){
    console.log(error);
  });
}

// Grant a new refresh token
function getAccessToken(assertion) {
  var data = {
    'grant_type':'urn:ietf:params:oauth:grant-type:jwt-bearer',
    'assertion':assertion
  };
  $.ajax({
    url:apiUrl + 'oauth2/auth',
    crossDomain:true, // se necessário cross domain
    data:data,
    type:'POST'
  })
  .done(function(data){
    getCompany(data.access_token,companyId)
  })
  .fail(function(error){
    console.log(error);
  });
}

// Get a company
function getCompany(authorization, companyId) {
  $.ajax({
    url:apiUrl + 'companies/' + companyId,
    crossDomain:true, // se necessário cross domain
    headers:{
      'Authorization':authorization
     }
  })
  .done(function(data){
    console.log(data);
  })
  .fail(function(error){
    console.log(error);
  });
}

getClientAssertion(clientId);

Observações

Para utilizar os endpoints com AJAX, é necessário realizar as 3 primeiras etapas acima e enviar o "access_token" no header de todas as requisições.

...

titleDica

...

Consulte as documentações Introdução à API REST e Exemplo de uso da API em AJAX para entender o funcionamento da API do fluig Identity e obter um exemplo de utilização em AJAX.