API me ngā pātaka kiritaki

Ko ngā mea katoa ka mahia e te taupānga tukutuku ki tētahi karere huna ka taea mā te HTTPS me te JSON. Ko te tauira noa he hōtaka, he rerenga mahi rānei e waihanga ana i tētahi karere huna ka hoatu i te hononga ki tētahi tangata, kia kore ai te pūnga whaimana e noho i roto i tētahi rangitaki, i tētahi tīkiti, i tētahi hītori kōrerorero rānei.

Ko te tohutoro pito mutunga katoa, me ngā anga tono me ngā anga whakautu me tētahi papatohu whakamātau, kei api.onetimesecret.com. Ka kōrero tēnei whārangi mō ngā mea e hiahia ana koe i mua i tō huaki i tērā.

URL pūtake

Ka haere ngā tono ki te rohe e pupuri ana i tō pūkete. He whakatakotoranga motuhake ia rohe, ā, kāore he mea e tāruatia i waenga i a rātou.

https://REGION.onetimesecret.com/api/v2

`REGION`	Kaihautū
`ca`	`ca.onetimesecret.com`
`eu`	`eu.onetimesecret.com`
`nz`	`nz.onetimesecret.com`
`uk`	`uk.onetimesecret.com`
`us`	`us.onetimesecret.com`

Ka whakautu tonu te kaihautū tahanga onetimesecret.com i ngā tono API, ā, ka ararere ki tētahi rohe hohe, engari titia mārikatia tētahi rohe kia mahi tonu ai tō pāhekoheko mēnā ka whakamutua taua hokinga. Tirohia Kei hea ō raraunga e noho ana mō te tikanga o ia rohe ki ō raraunga.

I tētahi rohe ritenga, kei te ara ōrite te API i tō rohe, ā, ka whakamahi ngā hononga ka waihangatia e ia i taua rohe:

https://secrets.example.com/api/v2

Ka whakaatu tētahi taupānga manaaki-ā-kiri i te API ōrite i te kaihautū e whakahaerehia ana e koe.

Whakamotuhēhē

Whakamahia te whakamotuhēhē HTTP Basic. Ko te ingoa kaiwhakamahi ko tō īmēra pūkete; ko te kupuhipa ko te tokena API mai i ō tautuhinga pūkete.

curl -u 'you@example.com:APITOKEN' https://eu.onetimesecret.com/api/v2/status

Ka mahi hoki te waihanga me te whakaatu karere huna me te kore whakamotuhēhē, me ngā tepe o te kaiwhakamahi ingoakore: he poto ake te wā ora mōrahi, he iti ake te rahi karere huna, ā, kāore he rārangi rihīti. Ka whiwhi ngā tono kua whakamotuhēhētia i ngā tepe o tō mahere, ā, ka puta i ō rihīti.

Tīmatanga tere

Waihangahia he karere huna e ora ana mō te hāora kotahi:

curl -u 'you@example.com:APITOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"secret": {"secret": "the password is hunter2", "ttl": 3600}}' \
  https://eu.onetimesecret.com/api/v2/secret/conceal

E rua ngā tuhinga kei roto i te whakautu. Ko record.secret.identifier te kī ka tohatohahia e koe, hei https://eu.onetimesecret.com/secret/IDENTIFIER. Ko record.receipt.identifier nōu: ka whakaatu mēnā kua tirohia te karere huna, ā, ka tuku i a koe ki te whakawareware wawe. Kaua rawa e tuku i te kī rihīti ki te kaiwhiwhi.

Tāpiritia "passphrase": "..." ki te ahanoa secret kia hiahiatia he kupu karapa i te tirohanga. He arowhai urunga te kupu karapa, ehara i te kī whakamuhumuhu: ko tētahi hash kotahi-ahunga anake e penapenatia ana e te ratonga, ā, ka arowhaitia i mua i te wetemuhumuhu i te uara. E kore e taea te whakaora i tētahi kupu karapa kua ngaro, nō reira kāore e taea te whakaatu, te whakawareware rānei i te karere huna; ka mukua ina pau tōna wā.

Whakaaturia tētahi karere huna, e pau ai:

curl -X POST -H 'Content-Type: application/json' -d '{}' \
  https://eu.onetimesecret.com/api/v2/secret/IDENTIFIER/reveal

Whakawarewaretia tētahi karere huna i mua i te tirohanga a tētahi, mā te kī rihīti:

curl -u 'you@example.com:APITOKEN' -X POST \
  https://eu.onetimesecret.com/api/v2/receipt/RECEIPT_IDENTIFIER/burn

Ngā putanga API

Ko v2 te API tūmatanui o nāianei: JSON ki roto, ki waho, ngā rihīti, ngā pito mutunga tūnga me te whakawareware. Hangaia ki runga i tēnei.
Ko v1 te API taketake kua whakawaehere-puka (POST /api/v1/share). Ka mahi tonu, ā, ko te nuinga o ngā pātaka hapori e whakamahi ana, engari me whakamahi ngā pāhekoheko hou i te v2.

Kua tuhia ēnei e rua ki api.onetimesecret.com.

Ngā pātaka kiritaki

Ngā pātaka kiritakiTe SDK ōkawa me ngā pātaka hapori, me ngā tuhipoka mō ngā mea e tautoko ana i te API v2, ngā rohe, me ngā rohe ritenga.

Tohutoro API katoaIa pito mutunga mō te v1 me te v2, ngā anga tono me ngā anga whakautu, me tētahi papatohu hei whakamātau i ngā karanga ki tō pūkete.

E hāngai ana

Kei hea ō raraunga e noho ana: te kōwhiri i tētahi rohe, me ngā mea ka noho ki roto.
Ngā rohe ritenga: ngā hononga karere huna me te urunga API i tō ake rohe.
Manaaki-ā-kiri: whakahaerehia te API i tō ake hanganga.
Ara kaiwhakawhanake: whakahaerehia te taupānga ki tō ake rorohiko ka takoha.