Consultar status do Onboarding

Descrição #

Método usado para validar o status do pagamento

Endpoints #

• Produção: https://api.bancosemear.com.br/softexpert/v2/api/get-workflow?workflowid=<RecordID>
• Homologação: https://hmlapi.bancosemear.com.br/softexpert/v2/api/get-workflow?workflowid=<RecordID>

Requisição (POST) #

Segue exemplo de requisição:

curl --location 'https://hmlapi.bancosemear.com.br/softexpert/v2/api/get-workflow?workflowid=<RecordID>' \
--header 'client_id: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'access_token: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \

Parâmetros de Requisição #

Cabeçalho #

• Authorization: Token bearer de autenticação do serviço integrador recebido através do método: Gerar Token de Autenticação (Serviço Integrador). Parâmetro obrigatório
• Client_id: ID de cliente usado para controle de acesso do gateway de APIs. Parâmetro obrigatório
• Access-token: Token recebido após executar o método: Gerar Token de Autenticação (Gateway API). Parâmetro obrigatório

Resposta #

Segue exemplo de resposta:

{
    "SOAP-ENV:Envelope": {
        "@xmlns:SOAP-ENC": "http://schemas.xmlsoap.org/soap/encoding/",
        "@xmlns:SOAP-ENV": "http://schemas.xmlsoap.org/soap/envelope/",
        "@xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
        "@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
        "SOAP-ENV:Body": {
            "getWorkflowResponse": {
                "@xmlns": "urn:workflow",
                "Code": "0",
                "Detail": "Instância encontrada",
                "InstanceStatus": "1",
                "ProcessID": "XX000000000",
                "StartDate": "2024-11-05 17:38:39",
                "StarterExternalUser": null,
                "StarterUser": "user",
                "Status": "SUCCESS",
                "Title": "WorkflowTitle"
            }
        }
    }
}

Parâmetros de Resposta #

Corpo (JSON) #

Retorno #