Autenticação API Key "Token JWT"

cuidado

  Pré-requisitos:
Este guia pressupõe que você já saiba como localizar um API Key na Conta de usuário.

O API Key permite que você faça requisições para o SoftExpert Suite. Para fazer isso você precisa incluir o seguinte parâmetro em suas chamadas:

HEADER PARAMETER	VALUE
Authorization	Requerido Token JWT de acesso válido seguindo o formato: <Token JWT>

O exemplo a seguir retorna informações sobre um documento usando a API para recuperar informações sobre documentos do componente SoftExpert Documento "/v1/document/view":

curl 'https://my-domain.softexpert.com/apigateway/v1/document/view' \
-H 'Authorization: <your_api_token>' \
-H 'Content-Type: application/json' \
-d '{ "iddocument": "<id_document>" }' -X POST

perigo

Caso o API Key tenha sido alterado ou o respectivo usuário associado ao token tenha sido bloqueado por algum motivo no SoftExpert Suite, todas as chamadas que o utilizam retornarão a seguinte mensagem: Valid GatewayJWT not found in the request or user is blocked!

As integrações existentes que utilizam o token antigo não serão capazes de fazer solicitações bem-sucedidas contra as APIs e Web Services do SoftExpert Suite.

Se tudo estiver correto, você receberá uma resposta semelhante a esta:

{
  "return": {
    "IDDOCUMENT": "0022511",
    "NMTITLE": "Drawing 0022511",
    "IDCATEGORY": "SD",
    "NMCATEGORY": "Steel Detailing",
    "STATUS": "2",
    "NRHITS": "3",
    "NMAUTHOR": "Tetsuo Kendo",
    "IDREVISION": "00",
    "DTDOCUMENT": "8/21/2015",
    "URL": "",
    "LINKSHARE": " ",
    "ATTRIBUTTES": {
      "item": [
        {
          "ATTRIBUTTENAME": "006",
          "ATTRIBUTTEVALUE": ""
        },
        {
          "ATTRIBUTTENAME": "CID",
          "ATTRIBUTTEVALUE": ""
        },
        {
          "ATTRIBUTTENAME": "CCN",
          "ATTRIBUTTEVALUE": {
            "document": ""
          }
        },
        {
          "ATTRIBUTTENAME": "SR",
          "ATTRIBUTTEVALUE": {
            "document": ""
          }
        },
        {
          "ATTRIBUTTENAME": "PS",
          "ATTRIBUTTEVALUE": {
            "document": "A4"
          }
        },
        {
          "ATTRIBUTTENAME": "Country",
          "ATTRIBUTTEVALUE": {
            "document": "Brazil"
          }
        },
        {
          "ATTRIBUTTENAME": "City",
          "ATTRIBUTTEVALUE": {
            "document": ""
          }
        }
      ]
    },
    "ELECTRONICFILE": {
      "item": {
        "FILENAME": "AcU-2.DES-2.9000-19-SDT-201 rev.B.dwg"
      }
    }
  }
}