Започване на работа

Актуализирано 2025-04-29

Базов URI

https://REGION.onetimesecret.com/api

Където REGION е или us, или eu.

Избор на местоположение на данни и регион

Изберете регион (напр. САЩ us.onetimesecret.com) или ЕС (eu.onetimesecret.com). Вижте Regions за всички опции.
Вземете предвид фактори като суверенитет на данните, латентност и изисквания за съответствие
ЗАБЕЛЕЖКА: По подразбиране onetimesecret.com остава оперативен и маршрутизира към активен център за данни, като се препоръчва използването на конкретна локализация, тъй като тази функционалност може да бъде изчерпана в бъдеще. ::

Удостоверяване

Поддържаме два режима на използване на API:

Автентичен достъп

https://USERNAME:APITOKEN@REGION.onetimesecret.com/api

Използвайте HTTP Basic Authentication за пълните възможности на API
Потребителското име е входът в профила ви
Паролата е API токенът от страницата на профила ви

Анонимен достъп

https://REGION.onetimesecret.com/api

Ограничена функционалност без удостоверяване
Идеален за бързо, еднократно споделяне на тайна
Може да се използва както за създаване, така и за извличане на тайни

Местоположение на данните

Onetime Secret поддържа множество географски центрове за данни. Ние следваме политика на нулев обмен на данни между регионите, като гарантираме пълна изолация на данните. Изберете подходящия център за данни за вашите нужди:

Център за данни на ЕС: eu.onetimesecret.com
Център за данни на САЩ: us.onetimesecret.com

Важни съображения:

Можете да изберете конкретно местоположение на данните, като преминете директно към желания домейн
Местонахождението на вашата тайна винаги е ясно от генерираната връзка (напр. us.onetimesecret.com/secret/abcd1234)
Забележка: Понастоящем достъпът през onetimesecret.com/api все още функционира, но се препоръчва използването на конкретна локалност, тъй като тази функционалност може да бъде изчерпана в бъдеще.

Потребителски домейни

Onetime Secret поддържа персонализирани конфигурации на домейни за организации със специфични изисквания за работа в мрежа или за брандиране чрез нашия план Identity Plus.

Предимства на потребителския домейн

Самостоятелна марка: Използвайте свой собствен домейн (напр. secrets.example.com) за достъп до API и споделяне на тайни
**Последователно потребителско изживяване: ** Поддържайте визуалната идентичност на организацията си и доверието към нея от страна на клиентите и партньорите ви.
Включване по време на обучението на служителите: Използвайте собствени домейни, за да затвърдите практиките за сигурност и работните процеси на вашата организация.

Премиум функция Потребителските домейни са налични в нашия план Identity Plus. Настройте за минути с нашите лесни за използване опции за конфигуриране. Научете повече. ::

Използване на API с потребителски домейни

Когато използвате потребителски домейн, всички крайни точки на API следват една и съща структура:

https://secrets.example.com/api

Състояние на системата

GET https://REGION.onetimesecret.com/api/v1/status Текущо състояние на системата.

Параметри: Няма

$ curl -u 'USERNAME:APITOKEN' https://eu.onetimesecret.com/api/v1/status
{"status": "nominal"}

$ curl -u 'USERNAME:APITOKEN' https://us.onetimesecret.com/api/v1/status
{"status": "nominal"}