API tools faq
paste
Advertisement
Guest User

verificaCodiceFiscale.yaml

a guest
Oct 2nd, 2023
385
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
YAML 10.92 KB | Software | 0 0
raw download clone embed print report
  1. #
  2. # Verifica validità codice fiscale
  3. x-commons:
  4.   ratelimit-headers: &ratelimit-headers
  5.     X-RateLimit-Limit:
  6.       $ref: '#/components/headers/X-RateLimit-Limit'
  7.     X-RateLimit-Remaining:
  8.       $ref: '#/components/headers/X-RateLimit-Remaining'
  9.     X-RateLimit-Reset:
  10.         $ref: '#/components/headers/X-RateLimit-Reset'
  11.   common-responses: &common-responses
  12.     '400':
  13.       $ref: '#/components/responses/400BadRequest'
  14.     '401':
  15.       $ref: '#/components/responses/401Unauthorized'
  16.     '429':
  17.       $ref: '#/components/responses/429TooManyRequests'
  18.     '503':
  19.       $ref: '#/components/responses/503ServiceUnavailable'
  20.     default:
  21.       $ref: '#/components/responses/default'
  22.  
  23. security:
  24.   - IBM-Client-Secret: []
  25.     IBM-Client-Id: []
  26.    
  27. openapi: 3.0.0
  28. info:
  29.   version: "1.0.0"
  30.  
  31.   title: |-
  32.     Verifica validità codice fiscale.
  33.   x-summary: >-
  34.     Verifica validità di codice fiscale di persona fisica e persona non fisica
  35.    
  36.   description: |
  37.    #### Documentazione
  38.     Questo servizio ritorna la validità di una dato codice fiscale descritta da
  39.     un campo di ritorno booleano nell oggetto json di response
  40.  
  41.     #### Note
  42.     Poiché il servizio effettua una verifica sul dato in input una
  43.     risposta verrà sempre ritornata con stato 200 anche se il codice fiscale
  44.     non fosse presente negli archivi.
  45.  
  46.     Nella risposta è presente un campo messaggio che riporta la stessa dizione
  47.     del servizio di verifica codice fiscale a libero accesso del sito istituzionale
  48.    
  49.     ##### Conformità con il modello di interoperabilità
  50.     L'Header di Throttling X-RateLimit-Reset non viene inviato in caso di https
  51.     status code 200, sarà presente solo in caso di 429
  52.  
  53.     #### Sicurezza
  54.     Pur essendo questa API di pubblico accesso, è richiesto l'invio delle
  55.     API Key che consentono all'infrastruttura di applicare le politiche di
  56.     throttling definite nell'ambito del piano sottoscritto
  57.      
  58.     #### Informazioni tecniche ed esempi
  59.  
  60.     Esempio:
  61.  
  62.     ```
  63.     curl --header "Content-Type: application/json" \
  64.          --request POST \
  65.          --data '{"codiceFiscale":"AAAZZZ00H00T000Z"}' \
  66.         https://agenziaentrate.gov.it/entrate/api/codice-fiscale/v0/verifica
  67.    
  68.     {
  69.       "codiceFiscale": "AAAZZZ00H00T000Z"
  70.       "valido": false,
  71.       "messaggio": "Codice fiscale non valido"
  72.     }
  73.     ```
  74.  
  75.   contact:
  76.     name: Agenzia delle Entrate
  77.     url: https://www.agenziaentrate.gov.it
  78.   x-audience:
  79.    - public
  80.   x-api-id: 5ca54741-8f62-4aad-ab79-13ae762920e3
  81.   license:
  82.     name: Apache 2.0
  83.     url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
  84. tags:
  85.   - name: infrastructure
  86.     description: |-
  87.       Endpoint non autenticato per la verifica dello stato del servizio
  88.   - name: verifiche
  89.     description: |-
  90.       verifica la validità e l'esistenza della codice fiscale in input
  91. servers:
  92.   - description: Produzione
  93.     url: https://api.agenziaentrate.gov.it/entrate/api/codice-fiscale/v0
  94.  
  95.  
  96. paths:
  97.   /status:
  98.     get:
  99.       summary: Ritorna lo stato dell'applicazione.
  100.       description: |
  101.         Ritorna lo stato dell'applicazione: 200 se funziona correttamente
  102.         o un errore se l'applicazione è temporaneamente indisponibile
  103.         per manutenzione o per un problema tecnico.
  104.       operationId: get_status
  105.       tags:
  106.        - infrastructure
  107.       responses:
  108.         <<: *common-responses
  109.         '200':
  110.           description: |
  111.            Il server ha ritornato lo status. In caso di problemi
  112.             ritorna sempre un problem+json.
  113.           headers:
  114.             <<: *ratelimit-headers
  115.           content:
  116.             application/problem+json:
  117.               schema:
  118.                 $ref: '#/components/schemas/Problem'
  119.   /verifica:
  120.     post:
  121.       summary: Effettua una validazione del codice fiscale in input.
  122.       operationId: post_verifica_codiceFiscale
  123.       tags:
  124.        - verifiche
  125.       description: |
  126.        Ritorna informazioni circa la validità del codice fiscale in input
  127.       requestBody:
  128.         required: true
  129.         content:
  130.           application/json:
  131.             schema:
  132.               $ref: '#/components/schemas/Richiesta'
  133.             examples:
  134.               codiceFiscaleAlfanumerico:
  135.                 value:
  136.                   codiceFiscale: 'AAAZZZ00H00T000Z'
  137.               codiceFiscaleNumerico:
  138.                 value:
  139.                   codiceFiscale: '06363391001'
  140.              
  141.          
  142.       responses:
  143.         <<: *common-responses
  144.         '200':
  145.           description: |
  146.            Il server è riuscito a verificare la validità del codice fiscale.
  147.           # header di throttling sono obbligatori
  148.           headers:
  149.             <<: *ratelimit-headers
  150.           content:
  151.             application/json:
  152.               schema:
  153.                 $ref: '#/components/schemas/VerificaCodiceFiscale'
  154.               examples:   # Esempi per ogni casistica
  155.                 CodiceFiscaleValido:
  156.                   value:
  157.                     codiceFiscale: '06363391001'
  158.                     valido: true
  159.                     messaggio: "Codice fiscale valido"
  160.                 CodiceFiscaleValidoNonUtilizzabile:
  161.                   value:
  162.                     codiceFiscale: '***********'
  163.                     valido: true
  164.                     messaggio: "Codice fiscale valido, non più utilizzabile in quanto aggiornato in altro codice fiscale"
  165.                 CodiceFiscaleNonValidoAggiornatoInAltro:
  166.                   value:
  167.                     codiceFiscale: '***********'
  168.                     valido: false
  169.                     messaggio: "Codice fiscale non utilizzabile in quanto aggiornato in altro codice fiscale"
  170.                 CodiceFiscaleNonValido:
  171.                   value:
  172.                     codiceFiscale: 'AAAZZZ00H00T000Z'
  173.                     valido: false
  174.                     messaggio: "Codice fiscale non valido"
  175. components:
  177.   schemas:
  178.     Richiesta:
  179.       type: object
  180.       properties:
  181.         codiceFiscale:
  182.           $ref: '#/components/schemas/CodiceFiscale'
  183.  
  184.    
  185.     CodiceFiscale:
  186.       type: string
  187.       minLength: 11
  188.       maxLength: 16
  189.       pattern: '^[0-9]{11}|(?:^(?:[A-Z][AEIOU][AEIOUX]|[B-DF-HJ-NP-TV-Z]{2}[A-Z]){2}(?:[\dLMNP-V]{2}(?:[A-EHLMPR-T](?:[04LQ][1-9MNP-V]|[15MR][\dLMNP-V]|[26NS][0-8LMNP-U])|[DHPS][37PT][0L]|[ACELMRT][37PT][01LM]|[AC-EHLMPR-T][26NS][9V])|(?:[02468LNQSU][048LQU]|[13579MPRTV][26NS])B[26NS][9V])(?:[A-MZ][1-9MNP-V][\dLMNP-V]{2}|[A-M][0L](?:[1-9MNP-V][\dLMNP-V]|[0L][1-9MNP-V]))[A-Z]$)'
  190.      
  191.       example: '06363391001'
  192.       description: 'può assumere un valore alfanumerico di lunghezza 16 o numerico di lunghezza 11 (i.e. 06363391001)'
  193.    
  194.  
  195.     VerificaCodiceFiscale:
  196.       type: object
  197.       properties:
  198.         codiceFiscale:
  199.           $ref: '#/components/schemas/CodiceFiscale'
  200.         valido:
  201.           type: boolean
  202.           example: true
  203.         messaggio:
  204.           type: string
  205.           example: "Codice fiscale valido"
  206.           description: "messaggio congurente con il serivizio a libero accesso di verifica codice fiscale sul sito istituzionale"
  207.        
  208.  
  209.    
  210.     Problem:
  211.       properties:
  212.         detail:
  213.           description: |
  214.            A human readable explanation specific to this occurrence of the
  215.             problem. You MUST NOT expose internal informations, personal
  216.             data or implementation details through this field.
  217.           example: Request took too long to complete.
  218.           type: string
  219.         instance:
  220.           description: |
  221.            An absolute URI that identifies the specific occurrence of the problem.
  222.             It may or may not yield further information if dereferenced.
  223.           format: uri
  224.           type: string
  225.         status:
  226.           description: |
  227.            The HTTP status code generated by the origin server for this occurrence
  228.             of the problem.
  229.           example: 503
  230.           exclusiveMaximum: true
  231.           format: int32
  232.           maximum: 600
  233.           minimum: 100
  234.           type: integer
  235.         title:
  236.           description: |
  237.            A short, summary of the problem type. Written in english and readable
  238.             for engineers (usually not suited for non technical stakeholders and
  239.             not localized); example: Service Unavailable
  240.           type: string
  241.         type:
  242.           default: about:blank
  243.           description: |
  244.            An absolute URI that identifies the problem type.  When dereferenced,
  245.             it SHOULD provide human-readable documentation for the problem type
  246.             (e.g., using HTML).
  247.           format: uri
  248.           type: string
  249.       type: object
  250.   securitySchemes:
  251.       IBM-Client-Secret:
  252.         type: apiKey
  253.         description: ''
  254.         name: X-IBM-Client-Secret
  255.         in: header
  256.       IBM-Client-Id:
  257.         type: apiKey
  258.         description: ''
  259.         name: X-IBM-Client-Id
  260.         in: header
  261.  
  262.   headers:
  263.     Retry-After:
  264.       description: |-
  265.         Retry contacting the endpoint *at least* after seconds.
  266.         See https://tools.ietf.org/html/rfc7231#section-7.1.3
  267.       schema:
  268.         type: string
  269.     WWW-Authenticate:
  270.       description: |-
  271.         Auth realm=APIkey
  272.         See https://tools.ietf.org/html/rfc7235#section-4.1
  273.       schema:
  274.         type: string
  275.     X-RateLimit-Limit:
  276.       description: The number of allowed requests in the current period
  277.       schema:
  278.         type: string
  279.     X-RateLimit-Remaining:
  280.       description: The number of remaining requests in the current period
  281.       schema:
  282.         type: string
  283.     X-RateLimit-Reset:
  284.       description: The number of seconds left in the current period
  285.       schema:
  286.         type: string
  287.  
  288.   responses:
  289.     400BadRequest:
  290.       content:
  291.         application/problem+json:
  292.           schema:
  293.             $ref: '#/components/schemas/Problem'
  294.       description: Bad Request
  295.     401Unauthorized:
  296.       content:
  297.         application/problem+json:
  298.           schema:
  299.             $ref: '#/components/schemas/Problem'
  300.       headers:
  301.         WWW-Authenticate:
  302.           $ref: '#/components/headers/WWW-Authenticate'
  303.       description: Not authorized
  304.     403Forbidden:
  305.       description: Forbidden
  306.     404NotFound:
  307.       description: Not Found
  308.     429TooManyRequests:
  309.       description: Too many requests
  310.       headers:
  311.         Retry-After:
  312.           $ref: '#/components/headers/Retry-After'
  313.         X-RateLimit-Limit:
  314.           $ref: '#/components/headers/X-RateLimit-Limit'
  315.         X-RateLimit-Remaining:
  316.           $ref: '#/components/headers/X-RateLimit-Remaining'
  317.         X-RateLimit-Reset:
  318.           $ref: '#/components/headers/X-RateLimit-Reset'
  319.     503ServiceUnavailable:
  320.       content:
  321.         application/problem+json:
  322.           schema:
  323.             $ref: '#/components/schemas/Problem'
  324.       description: Service Unavailable
  325.       headers:
  326.         Retry-After:
  327.           $ref: '#/components/headers/Retry-After'
  328.     default:
  329.       description: Unexpected error
  330.  
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!