Emails da pessoa física - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki

Issue: https://github.com/BRAConsultoria/SocialAPI-v2/issues/43

Obtendo os emails de uma pessoa física

Endpoint: /v1/pessoa-fisica/emails/{pf_id}/

GET

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "current":[
            {
               "email_id":"{id}",
               "email":"[email protected]",
               "email_verif":1,
               "email_class": "P",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            },
            {
               "email_id":"{id}",
               "email":"[email protected]",
               "email_verif":1,
               "email_class": "P",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "revisions":[
            {
               "email_id":"{id}",
               "email":"[email protected]",
               "email_verif":1,
               "email_class": "P",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            },
            {
               "email_id":"{id}",
               "email":"[email protected]",
               "email_verif":1,
               "email_class": "P",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "others":[
            {
               "email_id":"{id}",
               "email":"[email protected]",
               "email_verif":1,
               "email_class": "P",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ]
      }
   }
}

Forçando flush do cache

Endpoint /v1/pessoa-fisica/emails/flush/{pf_id}/

GET

Retorno conforme este endpoint.

Inserindo um email

Endpoint: /v1/pessoa-fisica/emails/

POST

Payload:

{
   "pf_id":"{id}",
   "email":"[email protected]",
   "email_class": "P", // P = Particular, I = Institucional
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 201

Removendo um email

Endpoint: /v1/pessoa-fisica/emails/{pf_id}/{email_id}/

DELETE

Payload:

{
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 204


Requisitando disparo de código via email

Endpoint: /v1/pessoa-fisica/emails/validate/{pf_id}/{email_id}/

GET

Retorno:

Status code: 200

Confirmando o código recebido via email

Endpoint: /v1/pessoa-fisica/emails/validate/

POST

Payload:

{
   "pf_id": "{pf_id}",
   "email_id": "{email_id}",
   "validate-code": "abcd123"
}

Retorno:

Status code: 202 (Aceito)

Validando manualmente um email

POST: /v1/pessoa-fisica/emails/manual-validate/

{
   "pf_id": "{pf_id}",
   "email_id": "{email_id}",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Status code: 202

Pesquisando pf_ids por email

Endpoint: /v1/pessoa-fisica/emails/{email}/search/

GET

Retorno:

{
   "success":true,
   "data": {
      "SocialAPI": [
        {
	  "pf_id": "{pf_id}",
	  "email_id":"{id}",
          "email":"[email protected]",
          "email_verif":1
          "email_class": "P"
        }
      ]
   }
}

200 | 404