Fíordheimhniú
- Authorization: ApiKey
- Ní sheoltar an eochair API ach i gceanntásc Authorization de POST /api/v1/auth/token. Ná cuir i JSON, in URL ná i bparaiméadair fiosrúcháin í.
- Authorization: Bearer
- Úsáid an comhartha a fhaightear d'iarratais acmhainní agus athnuaigh é de réir expires_at; cuirtear expires_in in iúl i soicindí.
Cén fáth comhartha a fháil ar dtús?
Úsáidtear an eochair API chun comhartha a fháil. Bíonn an comhartha bailí ar feadh 15 nóiméad agus is féidir é a úsáid le haghaidh roinnt iarratas. Ná seol ach an comhartha chuig acmhainní sa cheanntásc Authorization: Bearer.
Níl an eochair API i ngnáthiarratais. Ní thugann comhartha a sceitheadh rochtain ach go dtí go dtéann sé in éag. D’fhéadfadh eochair API goidte comharthaí nua a fháil fós.
Cá fhad a bhíonn comhartha bailí?
- expires_in
- 900 soicind, nó 15 nóiméad ón eisiúint. Ní chuireann iarratais síneadh leis an tréimhse bhailíochta.
- expires_at
- Am éaga in UTC. Féadfaidh na srianta rochtana reatha an comhartha a bhlocáil níos luaithe.
Cathain ba cheart comhartha nua a fháil?
Athúsáid an comhartha le haghaidh roinnt iarratas agus faigh ceann nua roimh expires_at. Ná faigh comhartha roimh gach oibríocht. Úsáid an eochair API chun an comhartha nua a fháil.
Rochtain diúltaithe agus atrialacha
- 401
- Ní chiallaíonn 401 i gcónaí go bhfuil an comhartha imithe in éag. Má tá, faigh ceann nua agus déan an léamh arís uair amháin ar a mhéad. Má thugann fáil an chomhartha 401 ar ais, seiceáil an eochair agus stop iarrachtaí uathoibríocha.
- 403
- Le 403, seiceáil ceadanna, srianta IP agus an plean. Ní chuireann comhartha nua rochtain chúlghairthe ar ais.
Srianta IP
- Ní sheachnaíonn comhartha rochtana ceadanna reatha na heochrach, teidlíochtaí an tsiopa, cúlghairm ná srianta IP.
- Más cuí, srian an eochair chuig seoltaí foinseacha an chomhtháthaithe.
- Is féidir leis an riarthóir an liosta a chur in eagar; ceadaítear suas le 32 seoladh.
Bainistiú eochracha
- Tá bainistíocht eochracha API ar leith ó cheadanna acmhainní an chomhtháthaithe.
- Is é owner amháin atá in ann ceadanna riaracháin chun eochracha a fheiceáil, a chruthú, a chur in eagar nó a scriosadh a thabhairt do ghrúpaí.
- Ní féidir le ball údaraithe ach gníomhartha a ceadaíodh dá ghrúpa a dhéanamh.
Teorainneacha ráta
Engine ≥ 4.143.0. Áirítear data.rate_limits ó pholasaí an tsiopa tráth a eisiúna i ngach freagra comhartha. Roinneann gach eochair na teorainneacha seo; ní athshocraíonn comhartha nua iad. D’fhéadfadh athrú plean teacht i bhfeidhm sula dtéann an comhartha in éag.
- read_per_minute
- Iarratais léitheoireachta sa nóiméad.
- write_per_minute
- Iarratais scríbhneoireachta sa nóiméad; ní thugann an luach seo cead scríbhneoireachta.
- auth_per_minute
- Iarratais ar chomhartha sa nóiméad, lena n-áirítear iarrachtaí fíordheimhnithe ar theip orthu.