Skip to content

Credenciales

Agregar credencial

api/v1/SAT/rfcs

Este servicio permite agregar una nueva credencia asociada a su usuario

URL

bash
    POST /api/v1/SAT/rfcs

Headers

Authorization: Bearer {token}

Accept: application/json

URL Params

txt
    None

Data Params

InputTypeRequiredValues acceptableDefault
rfcstringtrue
ciecstringtrue
id_cifstringfalse

Respuestas Posibles

Success

Code: 201 Created

Content:

json
{
  "data": {
    "id": 12,
    "user_id": 2,
    "rfc": "",
    "ciec": "",
    "id_cif": null,
    "created_at": "2024-07-31T02:15:20.000000Z",
    "updated_at": "2024-07-31T02:15:20.000000Z"
  }
}

Bad Request

Code: 400 Bad Request

Content:

json
{
  "message": "The RFC is already added to the list of credentials"
}

Unauthorized

Code: 401 Unauthorized

Content:

json
{
  "message": "Unauthenticated."
}

Unprocessable Content

Code: 422 Unprocessable Content

Content:

json
{
  "message": "The rfc field is required. (and 1 more error)",
  "errors": {
    "rfc": ["The rfc field is required."],
    "ciec": ["The ciec field is required."]
  }
}

Unprocessable Content

Code: 422 Unprocessable Content

Content:

json
{
  "errors": "The provided credentials are invalid."
}
Ejemplo con curl
bash
curl --location --request POST 'https://bridge.paladins.mx/api/v1/SAT/rfcs' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer zbSSVOcamRzUmgx6OD8FS3N3XvB3vhhViqk3iuK6' \
--form 'rfc=""' \
--form 'ciec=""' \
--form 'id_cif=""'

Obtener todas las credenciales

api/v1/SAT/rfcs

Este servicio permite obtener todas las credeciales que tiene asignadas el usuario

URL

bash
    GET /api/v1/SAT/rfcs

Headers

Authorization: Bearer {token}

Accept: application/json

URL Params

InputTypeRequiredValues acceptableDefault
pageintegerfalse

Data Params

txt
    None

Respuestas Posibles

Success

Code: 200 Success

Content:

json
{
  "data": [
    {
      "id": 1,
      "user_id": 2,
      "rfc": "",
      "ciec": "",
      "id_cif": "",
      "created_at": "2024-05-28T18:05:02.000000Z",
      "updated_at": "2024-05-28T19:02:57.000000Z"
    },
    {
      "id": 9,
      "user_id": 2,
      "rfc": "",
      "ciec": "",
      "id_cif": null,
      "created_at": "2024-07-31T01:55:20.000000Z",
      "updated_at": "2024-07-31T01:55:20.000000Z"
    },
    {
      "id": 10,
      "user_id": 2,
      "rfc": "",
      "ciec": "",
      "id_cif": "15030148912",
      "created_at": "2024-07-31T02:12:56.000000Z",
      "updated_at": "2024-07-31T02:12:56.000000Z"
    },
    {
      "id": 11,
      "user_id": 2,
      "rfc": "",
      "ciec": "",
      "id_cif": "",
      "created_at": "2024-07-31T02:15:15.000000Z",
      "updated_at": "2024-07-31T02:15:15.000000Z"
    },
    {
      "id": 12,
      "user_id": 2,
      "rfc": "",
      "ciec": "",
      "id_cif": null,
      "created_at": "2024-07-31T02:15:20.000000Z",
      "updated_at": "2024-07-31T02:15:20.000000Z"
    },
    {
      "id": 13,
      "user_id": 2,
      "rfc": "",
      "ciec": "",
      "id_cif": "15030148912",
      "created_at": "2024-07-31T02:20:54.000000Z",
      "updated_at": "2024-07-31T02:20:54.000000Z"
    },
    {
      "id": 14,
      "user_id": 2,
      "rfc": "",
      "ciec": "",
      "id_cif": null,
      "created_at": "2024-07-31T02:21:12.000000Z",
      "updated_at": "2024-07-31T02:21:12.000000Z"
    }
  ],
  "links": {
    "first": "https://bridge.paladins.mx/api/v1/SAT/rfcs?page=1",
    "last": "https://bridge.paladins.mx/api/v1/SAT/rfcs?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://bridge.paladins.mx/api/v1/SAT/rfcs?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://bridge.paladins.mx/api/v1/SAT/rfcs",
    "per_page": 15,
    "to": 7,
    "total": 7
  }
}

Unauthorized

Code: 401 Unauthorized

Content:

json
{
  "message": "Unauthenticated."
}
Ejemplo con curl
bash
curl --location --request GET 'https://bridge.paladins.mx/api/v1/SAT/rfcs' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 3|jIoi6R40Kic8IkKtT7XQu4nUM78BqwqxTsPKtQGi67f00c2a'

Ver Credencial

api/v1/SAT/rfcs/{rfc}?include=

Este servicio permite obtener una credencial por su rfc y sus relaciones

URL

bash
    GET /api/v1/SAT/rfcs/{rfc}

Headers

Authorization: Bearer {token}

Accept: application/json

URL Params

InputTypeRequiredValues acceptableDefault
rfcstringtrue
includestringfalsecsfs,certificados,ocofs,declaracions

Data Params

txt
    None

Respuestas Posibles

Success

Code: 200 Success

Content:

json
{
  "data": {
    "id": 10,
    "user_id": 2,
    "rfc": "",
    "ciec": "",
    "id_cif": "",
    "created_at": "2024-07-31T02:12:56.000000Z",
    "updated_at": "2024-07-31T02:12:56.000000Z"
  }
}

Success with include

Code: 200 Success

Content:

json
{
    "data": {
        "id": 7,
        "user_id": 2,
        "rfc": "",
        "ciec": "",
        "id_cif": "",
        "created_at": "2024-06-01T01:41:29.000000Z",
        "updated_at": "2024-06-01T01:41:29.000000Z",
        "csfs": [
            {
                "id": 10,
                "rfc_id": 7,
                "file_path": "RFC/CSFs/RFC-31-07-2024-21-21-07.pdf",
                "status": 1,
                "created_at": "2024-08-01T03:21:08.000000Z",
                "updated_at": "2024-08-01T03:21:08.000000Z"
            },
            ...

        ],
        "certificados": [
            {
                "id": 349,
                "rfc_id": 7,
                "serialNumber": "000010000007052716",
                "urlCer": "https://rdc.sat.gob.mx/rccf/000010/000007/05/27/19/000010000007052706.cer",
                "satType": "SELLO",
                "validFromString": "2024-02-21 14:15:06",
                "validToString": "2028-02-21 14:15:06",
                "valid": "Activo",
                "message": "OK",
                "codeHttp": 200,
                "created_at": "2024-08-01T03:23:15.000000Z",
                "updated_at": "2024-08-01T03:23:15.000000Z"
            },
            ...
            
        ],
        "ocofs": [
            {
                "id": 7,
                "rfc_id": 7,
                "file_path": "RFC/OCOFs/RFC-31-07-2024-21-21-44.pdf",
                "status": 0,
                "created_at": "2024-08-01T03:21:45.000000Z",
                "updated_at": "2024-08-01T03:22:06.000000Z"
            },
            ...
            
        ],
        "declaracions": [
            {
                "id": 407,
                "year": "2024",
                "num_operation": "240760167778",
                "declaration_type": "Complementaria",
                "type_complementary": "Modificación de Obligaciones",
                "period": "Junio",
                "capture_line": "",
                "presentation_date": "2024-07-30",
                "periodicity": "1-Mensual",
                "type_download": "queryStatement",
                "file_path": "RFC/declaraciones/newVersion/queryStatement/2024-240760167778-Junio.pdf",
                "system_version": "NEW",
                "created_at": "2024-08-01T03:20:14.000000Z",
                "updated_at": "2024-08-01T03:20:14.000000Z",
                "rfc_id": 7
            },

            ...
            
        ]
    }
}

Not Found

Code: 404 Not Found

Content:

json
{
  "message": "Record not found"
}

Unauthorized

Code: 401 Unauthorized

Content:

json
{
  "message": "Unauthenticated."
}
Ejemplo con curl
bash
curl --location --request GET 'https://bridge.paladins.mx/api/v1/SAT/rfcs/{rfc}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 3|jIoi6R40Kic8IkKtT7XQu4nUM78BqwqxTsPKtQGi67f00c2a'
bash
curl --location --request GET 'https://bridge.paladins.mx/api/v1/SAT/rfcs/{rfc}?include=csfs,certificados,ocofs,declaracions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 3|jIoi6R40Kic8IkKtT7XQu4nUM78BqwqxTsPKtQGi67f00c2a'

Editar credencial

api/v1/SAT/rfcs/{rfc}

Este servicio permite editar una credencial por su rfc

URL

bash
    PUT /api/v1/SAT/rfcs/{rfc}

Headers

Authorization: Bearer {token}

Accept: application/json

URL Params

InputTypeRequiredValues acceptableDefault
rfcstringtrue

Data Params

InputTypeRequiredValues acceptableDefault
rfcstringtrue
ciecstringtrue
id_cifstringfalse

Respuestas Posibles

Success

Code: 200 Success

Content:

json
{
  "data": {
    "id": 10,
    "user_id": 2,
    "rfc": "",
    "ciec": "",
    "id_cif": "",
    "created_at": "2024-07-31T02:12:56.000000Z",
    "updated_at": "2024-07-31T02:12:56.000000Z"
  }
}

Unauthorized

Code: 401 Unauthorized

Content:

json
{
  "message": "Unauthenticated."
}

Not Found

Code: 404 Not Found

Content:

json
{
  "message": "Record not found"
}
Ejemplo con curl
bash
curl --location --request PUT 'https://bridge.paladins.mx/api/v1/SAT/rfcs/RFC' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 3|jIoi6R40Kic8IkKtT7XQu4nUM78BqwqxTsPKtQGi67f00c2a' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rfc": "RFC",
    "ciec": "LEMERY231",
    "id_cif": "1503014891200"
}'

Eliminar credencial

api/v1/SAT/rfcs/{rfc}

Este servicio permite eliminar una credencial

URL

bash
    DELETE /api/v1/SAT/rfcs/{rfc}

Headers

Authorization: Bearer {token}

Accept: application/json

URL Params

InputTypeRequiredValues acceptableDefault
rfcstringtrue

Data Params

txt
    None

Respuestas Posibles

Success

Code: 204 No Content

Content:

json

Unauthorized

Code: 401 Unauthorized

Content:

json
{
  "message": "Unauthenticated."
}

Not Found

Code: 404 Not Found

Content:

json
{
  "message": "Record not found"
}
Ejemplo con curl
bash
curl --location --request DELETE 'https://bridge.paladins.mx/api/v1/SAT/rfcs/{rfc}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 3|jIoi6R40Kic8IkKtT7XQu4nUM78BqwqxTsPKtQGi67f00c2a'