Versão 1 da API para integração.
Integração via PHP
Criação de solicitações
Edição de solicitações
Envio de solicitações
A propriedade do conteúdo da Biblioteca API CredPago pertence a CredPago. O conteúdo da Biblioteca API CredPago só pode ser usado mediante a liberação de um usuário autorizado pela CredPago e apenas sendo utilizado com os serviços da CredPago. A biblioteca é oferecida e / ou distribuída "COMO ESTÁ", SEM GARANTIAS OU CONDIÇÕES DE QUALQUER TIPO, expressas ou implícitas. A CredPago não garante que a biblioteca ou qualquer conteúdo estará disponível ininterruptamente ou livre de erros, que os defeitos serão corrigidos ou que a biblioteca ou seus sistemas de suporte estejam livres de vírus ou bugs. Por favor, consulte a CredPago para saber mais sobre o produto.
Após pedir a liberação da API para uso em sua imobiliária/portal, aqui vai algumas regras básicas
Para consultas via API você deve enviar a requisição sempre acompanhada do email do usuário do sistema, como no exemplo a seguir, onde para consultar um imóvel é necesesário enviar o id do imóvel concatenado com o email do usuário:
Para insercão de dados você também deve enviar o email do usuário, porém o email irá no parametro como nos exemplos localizados na pasta tests.
Utilize a classe criaImovel() para criar um novo imóvel, note que, você deve preencher todos os parâmetros necessários para ser criado o imóvel.
criaImovel('[email protected]','1','1','5.000,00','120','3','89201330','Rua Mario Lobo','61','Centro','Joinville','SC')Com o envio de sua requisição, será retornado um cabeçalho Json, contendo um 'status', podendo ser 'sucesso' ou 'erro', e também uma mensagem com o tipo do erro, e caso o status seja de 'sucesso', o número do imóvel criado.
Para alterar um imóvel você deve utilizar a classe alteraImovel(), preenchendo todos os parâmetros como mostrado acima, porém dessa vez você deve enviar o número do imóvel a ser alterado junto a requisição, como mostra o exemplo abaixo:
alteraImovel('1234','[email protected]','1','1','4.000,00','120','3','89201330','Rua Mario Lobo','61','Centro','Joinville','SC')Todos os imóveis criados pela API serão gerados como um rascunho.
Para criar uma pessoa você deve ter o número do imóvel previamente criado e preencher os dados da pessoa em um array, como no exemplo abaixo:
criaPessoa('[email protected]', '1234', array[dados da pessoa] )Com o envio de sua requisição, será retornado um cabeçalho Json, contendo um 'status', podendo ser 'sucesso' ou 'erro', e também uma mensagem com o tipo do erro, e caso o status seja de 'sucesso', o número da pessoa criada.
Caso queira alterar uma pessoa você deve utilizar a classe alteraPessoa(), seguindo a mesma ideia do exemplo acima, porém ao invés de mandar o número do imóvel, você deve enviar o id da pessoa:
alteraPessoa('[email protected]', '1212', array[dados da pessoa] )Para criar um cartão você deve utilizar a classe criaCartao(), e preencher todos os parâmetros exigidos:
criaCartao('[email protected]','1212','MasterCard','5555555555555557','09/2022','10.000,00','8.000,00','1.240,00')Com o envio de sua requisição, será retornado um cabeçalho Json, contendo um 'status', podendo ser 'sucesso' ou 'erro', e também uma mensagem com o tipo do erro, e caso o status seja de 'sucesso' irá ser informado que seu cartão foi criado.
Para alteração, você deve utilizar a classe alteraCartao(), como no exemplo da alteração da pessoa, você deve adicionar como parâmetro o id da pessoa, como no exemplo abaixo:
alteraCartao('1212','[email protected]','1212','MasterCard','5555555555555557','09/2022','10.000,00','8.000,00','1.440,00')Note que, caso o tipo de imóvel seja 'Universitário', e o inquilino universitário seja menor de 24 anos, o mesmo não necessita de um cartão de crédito, porém o seu tutor sendo corresponsável ou um inquilino, necessita normalmente de um cartão válido.
Para o envio de um arquivo, sendo uma imagem ou um PDF, você deve utilizar a classe uploadPessoa(), contendo o e-mail do corretor e um array, cotendo o caminho do arquivo, tipo do arquivo e o nome do arquivo, caso não possua nenhum desses parâmetros, o servidor pode rejeitar o seu upload e bloquear sua chave por algumas horas, é necessário também o id da pessoa e o tipo de upload, como '1' sendo para faturas e '2' para documentos, exemplo abaixo:
uploadPessoa('[email protected]',array[tmp_name, type, name],'1212', 1)Com o envio de sua requisição, será retornado um cabeçalho Json, contendo um 'status', podendo ser 'sucesso' ou 'erro', e também uma mensagem com o tipo do erro, e caso o status seja de 'sucesso' irá ser informado que seu upload foi enviado.
A API dispõe de uma validação para saber se seu imóvel está pronto para o envio, para isso você deve utilizar a classe validaImovel(), no qual você deve preencher o número do imóvel, email do corretor e a opção, sendo '2' para envio da solicitação para análise e '1' para apenas verificação da solicitação.
validaImovel('1234', '[email protected]', 1)Note que, com a opção '1' selecionada, antes de ser enviado para análise, será feito uma verificação, podendo assim retornar um cabeçalho Json com um status de 'erro' e uma mensagem com o motivo do erro.
Para deletar uma pessoa você deve utilizar a classe deletaPessoa(), assim como em uma consulta, que você deve concatenar o email do corretor e o id/número da pessoa, para deletar uma pessoa você deve fazer o mesmo, como no exemplo abaixo:
$parametro = '[email protected]';
deletaPessoa($parametro)Com o envio de sua requisição será retornado um cabeçalho Json com o status e uma mensagem.
Para utilizar o simulador você deve serguir o exemplo abaixo:
criaSimulacao('[email protected]',array['26858344004', 'João', '5.000,00', 1])Com o envio de sua requisição será retornado um cabeçalho Json com o status da requisição.
Caso você queira utilizar o webook, envie um e-mail com o titulo 'Webhook API' para [email protected].