Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 12 Próxima »

Tópicos:

Além da integração via callback, é possível integrar sua aplicação diretamente pela API, como base_url você deve utilizar o endereço: 

Este endereço base complementa os endpoints listados abaixo.


1 - Listar Status de Atualização Cadastral:

Endpoint: /atualizacao_cadastral/api/v1/ws/formulario/get_all_status
Tipo: GET

Parâmetros:
	id_operadora
	mshash

Retorno Padrão
"status": true,
    "data": [
        {
            "id": 0,
            "nome": "Solicitado"
        },
        {
            "id": 1,
            "nome": "Aprovado"
        },
        {
            "id": 2,
            "nome": "Recusado"
        }
    ],
    "critica": [null],
    "timestamp": "2017-08-02T10:52:13-03:00",
    "msg":"Sucesso"
}


2 - Atualizar Status do Protocolo

Endpoint: /atualizacao_cadastral/api/v1/ws/formulario/atualiza_status_protocolo
Tipo: POST

Parâmetros:
	mshash: String
	id_operadora: Int
	matricula: String
	protocolo: String
	status: Int
	observacao: String

Retorno Padrão
{
    "status": true,
    "data": [],
    "critica": [],
    "timestamp": "2017-08-02T10:52:13-03:00",
    "msg":"Sucesso"
}

Os valores e o array do campo "alterados", que fica organizado em grupos, é dinamicamente alterado conforme a configuração do seu formulário.


3 - Detalhes do Protocolo de Atualização Cadastral

Endpoint: /atualizacao_cadastral/api/v1/ws/formulario/get_protocolo
Tipo: GET

Parâmetros:
	id_protocolo: Int
	id_operadora: Int
	mshash: String

Retorno Padrão
{
    "mshash" : "" ,
    "id_operadora": 9999,
    "id_aplicacao": 7,
    "protocolo": "XYZ042017060100319",
    "data": "2017-06-01 14:31:00",
    "status": 2,
    "matricula": "0006012371",
    "matricula_titular": "9999999999",
    "tipo": "t",
    "nome": "TESTE DANTAS DE ARAUJO",
    "observacao": "teste",
    "classe": null,
    "valores": [
        {
            "id_grupo": 1,
            "nome": "DADOS GERAIS",
            "alterados": [
                {
                    "id_campo": 5,
                    "id_protocolo_dados": 1243,
                    "id_protocolo": 55,
                    "valor": "123456",
                    "data_atualizacao": "2017-06-01 14:31:00",
                    "label": "Telefone residencial",
                    "nome": "atualizacao_cadastral_telefone",
                    "tipo": "text",
                    "tamanho": "6",
                    "classe": "telefone",
                    "id_grupo_campo": 1
                }
            ]
        },
    ]
}

Os valores e o array do campo "alterados", que fica organizado em grupos, é dinamicamente alterado conforme a configuração do seu formulário.



  • Sem rótulos