[{"data":1,"prerenderedAt":601},["ShallowReactive",2],{"openapi-specs-catalog":3,"openapi-nav-ru-Onlinesim-API-UN":38,"openapi-doc-\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-post-api-profile-php":173,"openapi-op-\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-post-api-profile-php":570},["Reactive",4],{"defaultLocale":5,"base":6,"specs":7,"specsMeta":11,"locales":35},"en","\u002Fopenapi_docs\u002F",[8,9,10],"Onlinesim-API-UN","Reseller-API-UN","Alternative-API-UN",[12,22,29],{"name":8,"fileName":8,"title":13,"version":14,"description":15,"basePath":16,"specsPath":17,"locales":18,"defaultLocale":5},"Onlinesim API","1.1","This API will allow you to access all services provided by Onlinesim: SMS receiving from a single specific service on a virtual number; rent a number ","Onlinesim-API-UN\u002F","\u002Fopenapi_docs\u002Fspecs\u002FOnlinesim-API-UN",{"en":19,"ru":20,"de":21},"English","Русский","Deutsch",{"name":9,"fileName":9,"title":23,"version":24,"description":25,"basePath":26,"specsPath":27,"locales":28,"defaultLocale":5},"Reseller API","1.0","The API is intended for current and potential Onlinesim partners. It allows you to monetize your numbers by providing them to our customers for receiv","Reseller-API-UN\u002F","\u002Fopenapi_docs\u002Fspecs\u002FReseller-API-UN",{"en":19,"ru":20,"de":21},{"name":10,"fileName":10,"title":30,"version":24,"description":31,"basePath":32,"specsPath":33,"locales":34,"defaultLocale":5},"Alternative API","Alternative API is compatible with the sms-activate protocol: programs written for it work with Onlinesim after changing the address to https:\u002F\u002Fonline","Alternative-API-UN\u002F","\u002Fopenapi_docs\u002Fspecs\u002FAlternative-API-UN",{"en":19,"ru":20,"de":21},[5,36,37],"ru","de",[39,43,48,53,86,125,134,163],{"text":13,"link":40,"icon":41,"description":42},"\u002Fru\u002FOnlinesim-API-UN\u002Finfo","icons\u002Fdocs\u002Finfo","Обзор API и введение",{"text":44,"link":45,"icon":46,"description":47},"Авторизация","\u002Fru\u002FOnlinesim-API-UN\u002Fauth","icons\u002Fdocs\u002Fauth","API-ключи, OAuth и схемы безопасности",{"text":49,"link":50,"icon":51,"description":52},"Компоненты","\u002Fru\u002FOnlinesim-API-UN\u002Fcomponents","icons\u002Fdocs\u002Fcomponents","Общие параметры запросов",{"text":54,"collapsed":55,"items":56,"description":84,"icon":85},"profile",false,[57,63,68,74,79],{"text":58,"link":59,"method":60,"path":61,"description":62,"deprecated":55},"getBalance","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getbalance-php","GET","\u002Fapi\u002FgetBalance.php","Получить баланс профиля",{"text":64,"link":65,"method":60,"path":66,"description":67,"deprecated":55},"getProfile","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getprofile-php","\u002Fapi\u002FgetProfile.php","Получить профиль",{"text":69,"link":70,"method":71,"path":72,"description":73,"deprecated":55},"setProfile","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-post-api-profile-php","POST","\u002Fapi\u002Fprofile.php","Изменить профиль (webhook URL и значения по умолчанию)",{"text":75,"link":76,"method":60,"path":77,"description":78,"deprecated":55},"getPaymentHistory","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getpaymenthistory-php","\u002Fapi\u002FgetPaymentHistory.php","Получить историю пополнений",{"text":80,"link":81,"method":60,"path":82,"description":83,"deprecated":55},"getWebhookLogs","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-webhook-logs","\u002Fapi\u002Fwebhook-logs","Получить журнал доставки вебхуков","разрешает доступ к API запросам, относящимся к профилю","icons\u002Fdocs\u002Ffolder",{"text":87,"collapsed":55,"items":88,"description":124,"icon":85},"single-service activations",[89,94,99,104,109,114,119],{"text":90,"link":91,"method":60,"path":92,"description":93,"deprecated":55},"setOperationRevise","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-setoperationrevise-php","\u002Fapi\u002FsetOperationRevise.php","Перейти к следующему полученному SMS операции",{"text":95,"link":96,"method":60,"path":97,"description":98,"deprecated":55},"getTariffs","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-gettariffs-php","\u002Fapi\u002FgetTariffs.php","Тарифы на одноразовые активации",{"text":100,"link":101,"method":60,"path":102,"description":103,"deprecated":55},"getNumbersStats","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getnumbersstats-php","\u002Fapi\u002FgetNumbersStats.php","Страны с сервисами, ценами и наличием номеров",{"text":105,"link":106,"method":60,"path":107,"description":108,"deprecated":55},"getPrice","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getprice-php","\u002Fapi\u002FgetPrice.php","Цена номера для сервиса",{"text":110,"link":111,"method":60,"path":112,"description":113,"deprecated":55},"getNum","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getnum-php","\u002Fapi\u002FgetNum.php","Купить виртуальный номер для выбранного сервиса",{"text":115,"link":116,"method":60,"path":117,"description":118,"deprecated":55},"getState","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getstate-php","\u002Fapi\u002FgetState.php","Получить информацию о номерах с активными операциями",{"text":120,"link":121,"method":60,"path":122,"description":123,"deprecated":55},"setOperationOk","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-setoperationok-php","\u002Fapi\u002FsetOperationOk.php","Завершить операцию активации","разрешает доступ к API для приема SMS от отдельных сервисов",{"text":126,"collapsed":55,"items":127,"description":133,"icon":85},"free numbers",[128],{"text":129,"link":130,"method":60,"path":131,"description":132,"deprecated":55},"getFreeList","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getfreelist","\u002Fapi\u002FgetFreeList","Получить список бесплатных номеров","разрешает доступ к API бесплатных номеров",{"text":135,"collapsed":55,"items":136,"description":162,"icon":85},"rent",[137,142,147,152,157],{"text":138,"link":139,"method":60,"path":140,"description":141,"deprecated":55},"tariffsRent","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-rent-tariffsrent-php","\u002Fapi\u002Frent\u002FtariffsRent.php","Получить информацию о тарифах по аренде номеров",{"text":143,"link":144,"method":60,"path":145,"description":146,"deprecated":55},"getRentNum","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-rent-getrentnum-php","\u002Fapi\u002Frent\u002FgetRentNum.php","Купить виртуальный номер телефона для аренды",{"text":148,"link":149,"method":60,"path":150,"description":151,"deprecated":55},"extendRentState","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-rent-extendrentstate-php","\u002Fapi\u002Frent\u002FextendRentState.php","Продлить срок аренды виртуального номера",{"text":153,"link":154,"method":60,"path":155,"description":156,"deprecated":55},"getRentState","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-rent-getrentstate-php","\u002Fapi\u002Frent\u002FgetRentState.php","Получить информацию о состоянии операции аренды",{"text":158,"link":159,"method":60,"path":160,"description":161,"deprecated":55},"closeRentNum","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-rent-closerentnum-php","\u002Fapi\u002Frent\u002FcloseRentNum.php","Завершить операцию аренды виртуального номера","разрешает доступ к API аренды",{"text":164,"collapsed":55,"items":165,"icon":172},"Вебхуки",[166],{"text":167,"link":168,"method":169,"path":170,"description":171,"deprecated":55},"newSmsWebhook","\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-post-newsms","WEBHOOK","\u002FnewSms","Получить SMS через webhook","icons\u002Fdocs\u002Fwebhook",{"title":73,"kind":174,"locale":36,"specName":8,"path":70,"operationKey":175,"method":176,"codeSamplesUrl":177,"description":73,"operation":178,"auth":417,"sections":445},"operation","Onlinesim-API-UN-post-api-profile-php","post","\u002Fopenapi_docs\u002Fapi\u002Fcode\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-post-api-profile-php.json",{"tags":179,"summary":180,"x-summary-ru":73,"x-summary-de":181,"description":182,"x-description-ru":183,"x-description-de":184,"operationId":69,"parameters":185,"requestBody":197,"responses":258,"security":410,"x-sidebar-title":69,"x-sidebar-title-ru":69,"x-sidebar-title-de":69},[54],"\u003Cp>Изменить профиль (webhook URL и значения по умолчанию)\u003C\u002Fp>","Profil ändern (Webhook-URL und Standardwerte)","\u003Cp>Сохраняет поля, переданные в \u003Ccode>profile\u003C\u002Fcode>, и возвращает обновлённый аккаунт. Непереданные поля не меняются. Работают и JSON, и данные формы (\u003Ccode>profile[webhook_url]=…\u003C\u002Fcode>).\u003C\u002Fp>\n\u003Caside class=\"my-4 rounded-lg border p-4 text-sm leading-relaxed not-prose border-brand-200 bg-brand-50 text-brand-950 theme-dark:text-gray-800\" role=\"note\">\u003Cdiv class=\"openapi-callout-body [&amp;_p:last-child]:mb-0 [&amp;_p]:mb-2\">\u003Cul>\n  \u003Cli>\u003Ccode>webhook_url\u003C\u002Fcode>: URL устанавливает адрес, \u003Ccode>null\u003C\u002Fcode> очищает его. Изменение также копируется во все Ваши существующие операции приёма SMS и аренды номеров, поэтому открытые операции начинают отправлять вебхуки на новый URL (или перестают их отправлять).\u003C\u002Fli>\n  \u003Cli>Для \u003Ccode>password\u003C\u002Fcode> нужны \u003Ccode>password_confirmation\u003C\u002Fcode> (то же значение) и \u003Ccode>old_password\u003C\u002Fcode>. Смена пароля завершает сеансы на других устройствах.\u003C\u002Fli>\n  \u003Cli>\u003Ccode>email\u003C\u002Fcode> сохраняется, только если у аккаунта ещё нет email; на него отправляется письмо активации.\u003C\u002Fli>\n\u003C\u002Ful>\n\u003C\u002Fdiv>\u003C\u002Faside>\u003Cp>\u003Ccode>number_region\u003C\u002Fcode> сервисом не используется и всегда равен \u003Ccode>null\u003C\u002Fcode>; переданное значение не сохраняется.\u003C\u002Fp>","Сохраняет поля, переданные в `profile`, и возвращает обновлённый аккаунт. Непереданные поля не меняются. Работают и JSON, и данные формы (`profile[webhook_url]=…`).\n\n::: info\n- `webhook_url`: URL устанавливает адрес, `null` очищает его. Изменение также копируется во все Ваши существующие операции приёма SMS и аренды номеров, поэтому открытые операции начинают отправлять вебхуки на новый URL (или перестают их отправлять).\n- Для `password` нужны `password_confirmation` (то же значение) и `old_password`. Смена пароля завершает сеансы на других устройствах.\n- `email` сохраняется, только если у аккаунта ещё нет email; на него отправляется письмо активации.\n:::\n\n`number_region` сервисом не используется и всегда равен `null`; переданное значение не сохраняется.","Speichert die in `profile` übergebenen Felder und gibt das aktualisierte Konto zurück. Nicht übergebene Felder bleiben unverändert. Sowohl JSON als auch Formulardaten (`profile[webhook_url]=…`) funktionieren.\n\n::: info\n- `webhook_url`: eine URL setzt sie, `null` löscht sie. Eine Änderung wird auch in alle Ihre bestehenden Einzeldienst-Aktivierungen und Mietnummern übernommen, sodass offene Vorgänge Webhooks an die neue URL senden (oder keine mehr senden).\n- `password` erfordert `password_confirmation` (gleicher Wert) und `old_password`. Ein geändertes Passwort meldet andere Geräte ab.\n- `email` wird nur gespeichert, wenn das Konto noch keine E-Mail hat; an sie wird eine Aktivierungs-E-Mail gesendet.\n:::\n\n`number_region` wird vom Dienst nicht verwendet und ist immer `null`; ein übergebener Wert wird nicht gespeichert.",[186],{"name":187,"in":188,"description":189,"x-description-ru":190,"x-description-de":191,"required":55,"schema":192},"lang","query","\u003Cp>Язык текстов в ответе (названия стран и сервисов, тексты статусов): \u003Ccode>fr\u003C\u002Fcode>, \u003Ccode>de\u003C\u002Fcode>, \u003Ccode>ru\u003C\u002Fcode>, \u003Ccode>en\u003C\u002Fcode> или \u003Ccode>zh\u003C\u002Fcode>. Принимается любым методом; методы без таких текстов отвечают одинаково на любом языке. Названия полей, коды ошибок и другие фиксированные значения остаются на английском. Без параметра: \u003Ccode>ru\u003C\u002Fcode> для getTariffs, getNumbersStats и getFreeList; в остальных — язык профиля для запросов с ключом, английский для запросов без ключа. Неподдерживаемое значение заменяется языком по умолчанию\u003C\u002Fp>","Язык текстов в ответе (названия стран и сервисов, тексты статусов): `fr`, `de`, `ru`, `en` или `zh`. Принимается любым методом; методы без таких текстов отвечают одинаково на любом языке. Названия полей, коды ошибок и другие фиксированные значения остаются на английском. Без параметра: `ru` для getTariffs, getNumbersStats и getFreeList; в остальных — язык профиля для запросов с ключом, английский для запросов без ключа. Неподдерживаемое значение заменяется языком по умолчанию","Sprache der Texte in der Antwort (Länder- und Dienstnamen, Statustexte): `fr`, `de`, `ru`, `en` oder `zh`. Jede Methode akzeptiert ihn; Methoden ohne solche Texte antworten in jeder Sprache gleich. Feldnamen, Fehlercodes und andere feste Werte bleiben auf Englisch. Ohne den Parameter: `ru` für getTariffs, getNumbersStats und getFreeList; sonst die Sprache des Profils bei Anfragen mit Schlüssel, Englisch bei Anfragen ohne. Ein nicht unterstützter Wert wird durch die Standardsprache ersetzt",{"type":193,"enum":194,"example":5},"string",[195,37,36,5,196],"fr","zh",{"required":198,"content":199},true,{"application\u002Fjson":200},{"schema":201},{"required":202,"properties":203,"type":257},[54],{"profile":204},{"description":205,"x-description-ru":206,"x-description-de":207,"properties":208,"type":257},"\u003Cp>Поля для изменения.\u003C\u002Fp>","Поля для изменения.","Zu ändernde Felder.",{"webhook_url":209,"number_country":217,"number_reject":223,"name":233,"username":237,"email":241,"password":245,"password_confirmation":249,"old_password":253},{"description":210,"x-description-ru":211,"x-description-de":212,"type":213,"format":215,"example":216},"\u003Cp>URL вебхука (любой URL вида \u003Ccode>scheme:\u002F\u002F…\u003C\u002Fcode>); \u003Ccode>null\u003C\u002Fcode> очищает его.\u003C\u002Fp>","URL вебхука (любой URL вида `scheme:\u002F\u002F…`); `null` очищает его.","Webhook-URL (jede URL der Form `scheme:\u002F\u002F…`); `null` löscht sie.",[193,214],"null","uri","https:\u002F\u002Fexample.com\u002Fhook",{"description":218,"x-description-ru":219,"x-description-de":220,"type":221,"example":222},"\u003Cp>Страна по умолчанию (телефонный код) для getNum и getPrice.\u003C\u002Fp>","Страна по умолчанию (телефонный код) для getNum и getPrice.","Standardland (Vorwahl) für getNum und getPrice.","integer",7,{"description":224,"x-description-ru":225,"x-description-de":226,"oneOf":227},"\u003Cp>Префиксы номеров, которые getNum пропускает по умолчанию; строка \u003Ccode>null\u003C\u002Fcode> очищает список.\u003C\u002Fp>","Префиксы номеров, которые getNum пропускает по умолчанию; строка `null` очищает список.","Standard-Nummernpräfixe, die getNum überspringt; die Zeichenkette `null` löscht sie.",[228,231],{"type":229,"items":230},"array",{"type":193},{"type":193,"enum":232},[214],{"description":234,"x-description-ru":235,"x-description-de":236,"type":193},"\u003Cp>До 255 символов.\u003C\u002Fp>","До 255 символов.","Bis zu 255 Zeichen.",{"description":238,"x-description-ru":239,"x-description-de":240,"type":193},"\u003Cp>До 255 символов, уникальное.\u003C\u002Fp>","До 255 символов, уникальное.","Bis zu 255 Zeichen, eindeutig.",{"description":242,"x-description-ru":243,"x-description-de":244,"type":193},"\u003Cp>Сохраняется, только если у аккаунта ещё нет email.\u003C\u002Fp>","Сохраняется, только если у аккаунта ещё нет email.","Wird nur gespeichert, wenn das Konto noch keine E-Mail hat.",{"description":246,"x-description-ru":247,"x-description-de":248,"type":193},"\u003Cp>Новый пароль, не короче 6 символов.\u003C\u002Fp>","Новый пароль, не короче 6 символов.","Neues Passwort, mindestens 6 Zeichen.",{"description":250,"x-description-ru":251,"x-description-de":252,"type":193},"\u003Cp>То же, что \u003Ccode>password\u003C\u002Fcode>.\u003C\u002Fp>","То же, что `password`.","Derselbe Wert wie `password`.",{"description":254,"x-description-ru":255,"x-description-de":256,"type":193},"\u003Cp>Текущий пароль; обязателен вместе с \u003Ccode>password\u003C\u002Fcode>.\u003C\u002Fp>","Текущий пароль; обязателен вместе с `password`.","Aktuelles Passwort; zusammen mit `password` erforderlich.","object",{"200":259,"429":376,"456":393},{"description":260,"x-description-ru":261,"x-description-de":262,"content":263},"\u003Cp>Сохранённый аккаунт, ошибки валидации или код ошибки:\u003C\u002Fp>\n\u003Cul>\n  \u003Cli>\u003Ccode>ERROR_PARAMS\u003C\u002Fcode> — \u003Ccode>profile\u003C\u002Fcode> не передан или не является объектом\u003C\u002Fli>\n  \u003Cli>\u003Ccode>Query Exception\u003C\u002Fcode> — база данных отклонила изменение\u003C\u002Fli>\n\u003C\u002Ful>","Сохранённый аккаунт, ошибки валидации или код ошибки:\n- `ERROR_PARAMS` — `profile` не передан или не является объектом\n- `Query Exception` — база данных отклонила изменение\n","Gespeichertes Konto, Validierungsfehler oder ein Fehlercode:\n- `ERROR_PARAMS` — `profile` fehlt oder ist kein Objekt\n- `Query Exception` — die Datenbank hat die Änderung abgelehnt\n",{"application\u002Fjson":264},{"schema":265,"examples":362},{"oneOf":266},[267,341,348,355],{"required":268,"properties":271,"type":257},[269,270],"response","user",{"response":272,"user":275},{"type":193,"enum":273,"example":274},[274],"1",{"description":276,"x-description-ru":277,"x-description-de":278,"properties":279,"type":257},"\u003Cp>Аккаунт пользователя в сохранённом виде (\u003Ccode>getProfile\u003C\u002Fcode> → \u003Ccode>profile\u003C\u002Fcode>, \u003Ccode>profile.php\u003C\u002Fcode> → \u003Ccode>user\u003C\u002Fcode>). Могут приходить и поля, не перечисленные здесь.\u003C\u002Fp>","Аккаунт пользователя в сохранённом виде (`getProfile` → `profile`, `profile.php` → `user`). Могут приходить и поля, не перечисленные здесь.","Das Benutzerkonto wie gespeichert (`getProfile` → `profile`, `profile.php` → `user`). Es können weitere, hier nicht aufgeführte Felder vorkommen.",{"id":280,"hash_id":282,"name":284,"username":287,"email":289,"email_verified_at":292,"apikey":294,"api_access":295,"locale":304,"currency":305,"number_country":307,"number_reject":309,"number_region":318,"webhook_url":323,"number":328,"country":330,"is_api":332,"active":333,"block":334,"disable":335,"verify":336,"ugroup":337,"first_login":338,"is_project_subscription":339,"created_at":340},{"type":221,"example":281},100001,{"type":283},[193,214],{"type":285,"example":286},[193,214],"John",{"type":288},[193,214],{"type":290,"example":291},[193,214],"user@example.com",{"type":293},[193,214],{"type":193},{"description":296,"x-description-ru":297,"x-description-de":298,"oneOf":299},"\u003Cp>Доступ к API: \u003Ccode>false\u003C\u002Fcode> — выключен, \u003Ccode>true\u003C\u002Fcode> — включён с любых IP, или объект \u003Ccode>{\"&lt;ip&gt;\": \"&lt;ip&gt;\"}\u003C\u002Fcode> — включён только с этих IP.\u003C\u002Fp>","Доступ к API: `false` — выключен, `true` — включён с любых IP, или объект `{\"\u003Cip>\": \"\u003Cip>\"}` — включён только с этих IP.","API-Zugriff: `false` — aus, `true` — von jeder IP aus erlaubt, oder ein Objekt `{\"\u003Cip>\": \"\u003Cip>\"}` — nur von diesen IPs aus erlaubt.",[300,302],{"type":301},"boolean",{"type":257,"additionalProperties":303},{"type":193},{"type":193,"example":5},{"type":193,"example":306},"USD",{"description":218,"x-description-ru":219,"x-description-de":220,"type":308,"example":222},[221,214],{"description":310,"x-description-ru":311,"x-description-de":312,"oneOf":313},"\u003Cp>Префиксы номеров, которые getNum пропускает по умолчанию; \u003Ccode>null\u003C\u002Fcode>, если ни разу не задавались, \u003Ccode>{}\u003C\u002Fcode>, если список очищен.\u003C\u002Fp>","Префиксы номеров, которые getNum пропускает по умолчанию; `null`, если ни разу не задавались, `{}`, если список очищен.","Standard-Nummernpräfixe, die getNum überspringt; `null`, wenn nie gesetzt, `{}`, wenn geleert.",[314,316,317],{"type":229,"items":315},{"type":193},{"type":257},{"type":214},{"description":319,"x-description-ru":320,"x-description-de":321,"type":322},"\u003Cp>Сервисом не используется; всегда \u003Ccode>null\u003C\u002Fcode>.\u003C\u002Fp>","Сервисом не используется; всегда `null`.","Wird vom Dienst nicht verwendet; immer `null`.",[221,214],{"description":324,"x-description-ru":325,"x-description-de":326,"type":327},"\u003Cp>URL, на который приходит вебхук \u003Ccode>newSms\u003C\u002Fcode>; \u003Ccode>null\u003C\u002Fcode> или пустая строка — вебхуки не отправляются.\u003C\u002Fp>","URL, на который приходит вебхук `newSms`; `null` или пустая строка — вебхуки не отправляются.","URL, an die der Webhook `newSms` gesendet wird; `null` oder leer — keine Webhooks.",[193,214],{"type":329},[221,214],{"type":331},[193,214],{"type":301},{"type":193},{"type":221},{"type":301},{"type":221},{"type":221},{"type":301},{"type":301},{"type":193},{"description":342,"x-description-ru":343,"x-description-de":344,"required":345,"properties":346,"type":257},"\u003Cp>Ошибки валидации: поле → список сообщений; неверный \u003Ccode>old_password\u003C\u002Fcode> даёт \u003Ccode>{\"old_password\": \"&lt;сообщение&gt;\"}\u003C\u002Fcode>.\u003C\u002Fp>","Ошибки валидации: поле → список сообщений; неверный `old_password` даёт `{\"old_password\": \"\u003Cсообщение>\"}`.","Validierungsfehler: Feld → Liste von Meldungen; ein falsches `old_password` ergibt `{\"old_password\": \"\u003CMeldung>\"}`.",[269],{"response":347},{"type":257,"additionalProperties":198},{"required":349,"properties":350,"type":257},[269],{"response":351},{"type":193,"enum":352},[353,354],"ERROR_PARAMS","Query Exception",{"required":356,"properties":357,"type":257,"additionalProperties":198},[269],{"response":358},{"description":359,"x-description-ru":360,"x-description-de":361,"type":193},"\u003Cp>Код ошибки. Коды, которые может вернуть любой метод, перечислены во введении; у каждого метода — свои. Список не закрыт: неизвестный код обрабатывайте как общую ошибку и записывайте в лог.\u003C\u002Fp>","Код ошибки. Коды, которые может вернуть любой метод, перечислены во введении; у каждого метода — свои. Список не закрыт: неизвестный код обрабатывайте как общую ошибку и записывайте в лог.","Fehlercode. Die Codes, die jede Methode liefern kann, stehen in der Einleitung; jede Methode führt ihre eigenen auf. Die Liste ist nicht geschlossen: behandeln Sie einen unbekannten Code als allgemeinen Fehler und protokollieren Sie ihn.",{"Validation error":363,"ERROR_PARAMS":371},{"summary":364,"x-summary-ru":365,"x-summary-de":366,"value":367},"\u003Cp>\u003Ccode>webhook_url\u003C\u002Fcode> — не URL\u003C\u002Fp>","`webhook_url` — не URL","`webhook_url` ist keine URL",{"response":368},{"webhook_url":369},[370],"The webhook url field must be a valid URL.",{"summary":372,"x-summary-ru":373,"x-summary-de":374,"value":375},"\u003Cp>\u003Ccode>profile\u003C\u002Fcode> не передан\u003C\u002Fp>","`profile` не передан","`profile` nicht übergeben",{"response":353},{"description":377,"x-description-ru":378,"x-description-de":379,"content":380},"\u003Cp>HTTP 429: больше 400 запросов в минуту с одного профиля (с одного IP для запросов без ключа) или больше 200 запросов в минуту с одного профиля к getNum, getPrice, getState и setOperationOk вместе\u003C\u002Fp>","HTTP 429: больше 400 запросов в минуту с одного профиля (с одного IP для запросов без ключа) или больше 200 запросов в минуту с одного профиля к getNum, getPrice, getState и setOperationOk вместе","HTTP 429: mehr als 400 Anfragen pro Minute von einem Profil (von einer IP bei Anfragen ohne Schlüssel) oder mehr als 200 Anfragen pro Minute von einem Profil an getNum, getPrice, getState und setOperationOk zusammen",{"application\u002Fjson":381},{"schema":382,"examples":386},{"required":383,"properties":384,"type":257,"additionalProperties":198},[269],{"response":385},{"description":359,"x-description-ru":360,"x-description-de":361,"type":193},{"Rate limit":387},{"summary":388,"x-summary-ru":389,"x-summary-de":390,"value":391},"\u003Cp>Превышен лимит запросов\u003C\u002Fp>","Превышен лимит запросов","Anfragelimit überschritten",{"response":392},"TRY_AGAIN_LATER",{"description":394,"x-description-ru":395,"x-description-de":396,"content":397},"\u003Cp>HTTP 456: API-ключ неверный или OAuth-токен истёк. Публичные методы отвечают так же, если передан неверный ключ\u003C\u002Fp>","HTTP 456: API-ключ неверный или OAuth-токен истёк. Публичные методы отвечают так же, если передан неверный ключ","HTTP 456: Der API-Schlüssel ist ungültig oder das OAuth-Token ist abgelaufen. Öffentliche Methoden antworten genauso, wenn ein ungültiger Schlüssel übergeben wird",{"application\u002Fjson":398},{"schema":399,"examples":403},{"required":400,"properties":401,"type":257,"additionalProperties":198},[269],{"response":402},{"description":359,"x-description-ru":360,"x-description-de":361,"type":193},{"Invalid key":404},{"summary":405,"x-summary-ru":406,"x-summary-de":407,"value":408},"\u003Cp>Неверный API-ключ или истёкший токен\u003C\u002Fp>","Неверный API-ключ или истёкший токен","Ungültiger API-Schlüssel oder abgelaufenes Token",{"response":409},"ERROR_WRONG_KEY",[411,413,415],{"apikey":412},[],{"BearerAuth":414},[],{"OAuth2":416},[],{"apikey":418,"BearerAuth":424,"OAuth2":430},{"type":419,"description":420,"x-description-ru":421,"x-description-de":422,"name":423,"in":188},"apiKey","\u003Cp>Секретный ключ, используемый для упрощенной авторизации в API Onlinesim.\u003C\u002Fp>\n\u003Chr>\n\u003Ch4>Как получить API ключ:\u003C\u002Fh4>\n\u003Col>\n  \u003Cli>Авторизоваться в личном кабинете, перейти в \u003Ca href=\"\u002Fv2\u002Fprofile\u002F\">настройки профиля\u003C\u002Fa>, выбрать вкладку \u003Cstrong>API\u003C\u002Fstrong>.\u003C\u002Fli>\n  \u003Cli>Ключ будет указан в строке \u003Ccode>API key\u003C\u002Fcode>. Его необходимо скопировать и добавить в Ваше приложение\u002Fпрограмму.\u003C\u002Fli>\n\u003C\u002Fol>\n\u003Chr>\n\u003Ch4>Как использовать:\u003C\u002Fh4>\n\u003Col>\n  \u003Cli>Все запросы к текущемуAPI Onlinesim (кроме публичных: \u003Ca href=\"\u002Fopenapi_docs\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-gettariffs-php\">getTariffs\u003C\u002Fa>, \u003Ca href=\"\u002Fopenapi_docs\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getnumbersstats-php\">getNumbersStats\u003C\u002Fa>, \u003Ca href=\"\u002Fopenapi_docs\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-rent-tariffsrent-php\">tariffsRent\u003C\u002Fa> и \u003Ca href=\"\u002Fopenapi_docs\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getfreelist\">getFreeList\u003C\u002Fa>) должны содержать API ключ. Публичный метод всё равно проверяет ключ, если он передан.\u003C\u002Fli>\n  \u003Cli>\n    \u003Cp>API ключ можно указать как параметр запроса, например:\u003C\u002Fp>\n    \u003Cpre data-lang=\"text\">\u003Ccode class=\"code-hl code-ln\" style=\"--ln-digits:1\">\u003Cspan class=\"line\">   https:\u002F\u002Fonlinesim.io\u002Fapi\u002FgetBalance.php?apikey={apikey}\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\n    \u003Cp>Ключ также принимается в заголовке \u003Ccode>Authorization: Bearer\u003C\u002Fcode> (см. BearerAuth), в заголовке \u003Ccode>apikey\u003C\u002Fcode>, в поле \u003Ccode>apikey\u003C\u002Fcode> тела POST-запроса и под именем \u003Ccode>key\u003C\u002Fcode> в любом из этих мест.\u003C\u002Fp>\n  \u003C\u002Fli>\n\u003C\u002Fol>\n\u003Caside class=\"my-4 rounded-lg border p-4 text-sm leading-relaxed not-prose border-brand-200 bg-brand-50 text-brand-950 theme-dark:text-gray-800\" role=\"note\">\u003Cdiv class=\"openapi-callout-body [&amp;_p:last-child]:mb-0 [&amp;_p]:mb-2\">\u003Cp>Использование API ключа представляет собой способ для упрощенной авторизации запросов. Мы рекомендуем использовать OAuth 2.0 для более безопасной работы с данными.\u003C\u002Fp>\n\u003Cp>Для получения более подробной информации, пожалуйста, обратитесь к \u003Ca href=\"https:\u002F\u002Foauth.net\u002F2\u002F\" target=\"_blank\" rel=\"noopener noreferrer\">официальной документации OAuth 2.0\u003C\u002Fa>.\u003C\u002Fp>\n\u003C\u002Fdiv>\u003C\u002Faside>","Секретный ключ, используемый для упрощенной авторизации в API Onlinesim.\n\n---\n\n#### Как получить API ключ:\n\n1. Авторизоваться в личном кабинете, перейти в [настройки профиля](https:\u002F\u002Fonlinesim.io\u002Fv2\u002Fprofile\u002F), выбрать вкладку **API**.\n2. Ключ будет указан в строке `API key`. Его необходимо скопировать и добавить в Ваше приложение\u002Fпрограмму.\n\n---\n\n#### Как использовать:\n\n1. Все запросы к текущемуAPI Onlinesim (кроме публичных: [getTariffs](\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-gettariffs-php), [getNumbersStats](\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getnumbersstats-php), [tariffsRent](\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-rent-tariffsrent-php) и [getFreeList](\u002Fru\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getfreelist)) должны содержать API ключ. Публичный метод всё равно проверяет ключ, если он передан.\n2. API ключ можно указать как параметр запроса, например:\n\n          https:\u002F\u002Fonlinesim.io\u002Fapi\u002FgetBalance.php?apikey={apikey}\n\n   Ключ также принимается в заголовке `Authorization: Bearer` (см. BearerAuth), в заголовке `apikey`, в поле `apikey` тела POST-запроса и под именем `key` в любом из этих мест.\n\n::: tip\nИспользование API ключа представляет собой способ для упрощенной авторизации запросов. Мы рекомендуем использовать OAuth 2.0 для более безопасной работы с данными.\n\nДля получения более подробной информации, пожалуйста, обратитесь к [официальной документации OAuth 2.0](https:\u002F\u002Foauth.net\u002F2\u002F).\n:::\n","Geheimer Schlüssel, der für die vereinfachte Autorisierung in der Onlinesim API verwendet wird.\n\n---\n\n#### So erhalten Sie einen API-Schlüssel:\n\n1. Melden Sie sich im persönlichen Konto an, gehen Sie zu den [Profileinstellungen](https:\u002F\u002Fonlinesim.io\u002Fv2\u002Fprofile\u002F), wählen Sie die Registerkarte **API**.\n2. Der Schlüssel wird in der Zeile `API key` angezeigt. Er muss kopiert und zu Ihrer Anwendung\u002FProgramm hinzugefügt werden.\n\n---\n\n#### So verwenden Sie ihn:\n\n1. Alle Anfragen an die aktuelle Onlinesim API (außer den öffentlichen: [getTariffs](\u002Fde\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-gettariffs-php), [getNumbersStats](\u002Fde\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getnumbersstats-php), [tariffsRent](\u002Fde\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-rent-tariffsrent-php) und [getFreeList](\u002Fde\u002FOnlinesim-API-UN\u002FOnlinesim-API-UN-get-api-getfreelist)) müssen einen API-Schlüssel enthalten. Eine öffentliche Methode prüft einen übergebenen Schlüssel trotzdem.\n2. Der API-Schlüssel kann als Anfrageparameter angegeben werden, z. B.:\n\n          https:\u002F\u002Fonlinesim.io\u002Fapi\u002FgetBalance.php?apikey={apikey}\n\n   Der Schlüssel wird auch im Header `Authorization: Bearer` (siehe BearerAuth), in einem Header `apikey`, als Feld `apikey` eines POST-Bodys und unter dem Namen `key` an jeder dieser Stellen akzeptiert.\n\n::: tip\nDie Verwendung des API-Schlüssels ist eine Methode zur vereinfachten Autorisierung von Anfragen. Wir empfehlen die Verwendung von OAuth 2.0 für eine sicherere Arbeit mit Daten.\n\nFür weitere Informationen wenden Sie sich bitte an die [offizielle OAuth 2.0-Dokumentation](https:\u002F\u002Foauth.net\u002F2\u002F).\n:::\n","apikey",{"type":425,"description":426,"x-description-ru":427,"x-description-de":428,"scheme":429},"http","\u003Cp>API ключ также можно использовать для авторизации в заголовке запроса, используя схему \u003Ccode>Authorization: Bearer\u003C\u002Fcode>, например:\u003C\u002Fp>\n\u003Cpre data-lang=\"bash\">\u003Ccode class=\"code-hl code-ln\" style=\"--ln-digits:1\">\u003Cspan class=\"line\">\u003Cspan class=\"tok-fn\">curl\u003C\u002Fspan> \u003Cspan class=\"tok-var\">-H\u003C\u002Fspan> \u003Cspan class=\"tok-string\">&quot;Authorization: Bearer {apikey}&quot;\u003C\u002Fspan> https:\u002F\u002Fonlinesim.io\u002Fapi\u002FgetBalance.php\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cp>Тот же заголовок передаёт access token OAuth 2.0 (см. OAuth2).\u003C\u002Fp>\n\u003Caside class=\"my-4 rounded-lg border p-4 text-sm leading-relaxed not-prose border-brand-200 bg-brand-50 text-brand-950 theme-dark:text-gray-800\" role=\"note\">\u003Cdiv class=\"openapi-callout-body [&amp;_p:last-child]:mb-0 [&amp;_p]:mb-2\">\u003Cp>Использование API ключа представляет собой способ для упрощенной авторизации запросов. Мы рекомендуем использовать OAuth 2.0 для более безопасной работы с данными.\u003C\u002Fp>\n\u003Cp>Для получения более подробной информации, пожалуйста, обратитесь к \u003Ca href=\"https:\u002F\u002Foauth.net\u002F2\u002F\" target=\"_blank\" rel=\"noopener noreferrer\">официальной документации OAuth 2.0\u003C\u002Fa>.\u003C\u002Fp>\n\u003C\u002Fdiv>\u003C\u002Faside>","API ключ также можно использовать для авторизации в заголовке запроса, используя схему `Authorization: Bearer`, например:\n\n```bash\ncurl -H \"Authorization: Bearer {apikey}\" https:\u002F\u002Fonlinesim.io\u002Fapi\u002FgetBalance.php\n```\n\nТот же заголовок передаёт access token OAuth 2.0 (см. OAuth2).\n\n::: tip\nИспользование API ключа представляет собой способ для упрощенной авторизации запросов. Мы рекомендуем использовать OAuth 2.0 для более безопасной работы с данными.\n\nДля получения более подробной информации, пожалуйста, обратитесь к [официальной документации OAuth 2.0](https:\u002F\u002Foauth.net\u002F2\u002F).\n:::\n","Der API-Schlüssel kann auch für die Autorisierung im Anfrageheader verwendet werden, indem das Schema `Authorization: Bearer` verwendet wird, z. B.:\n\n```bash\ncurl -H \"Authorization: Bearer {apikey}\" https:\u002F\u002Fonlinesim.io\u002Fapi\u002FgetBalance.php\n```\n\nDerselbe Header überträgt ein OAuth 2.0 Access Token (siehe OAuth2).\n\n::: tip\nDie Verwendung des API-Schlüssels ist eine Methode zur vereinfachten Autorisierung von Anfragen. Wir empfehlen die Verwendung von OAuth 2.0 für eine sicherere Arbeit mit Daten.\n\nFür weitere Informationen wenden Sie sich bitte an die [offizielle OAuth 2.0-Dokumentation](https:\u002F\u002Foauth.net\u002F2\u002F).\n:::\n","bearer",{"type":431,"description":432,"x-description-ru":433,"x-description-de":434,"flows":435},"oauth2","\u003Cp>\u003Cspan id=\"OAUTH\">\u003C\u002Fspan>\u003C\u002Fp>\n\u003Ch3>OAuth 2.0\u003C\u002Fh3>\n\u003Cp>Протокол OAuth 2.0 поддерживает несколько сценариев авторизации, для работы с нашим API можно использовать сценарии Authorization Code Flow или Implicit Flow.\u003C\u002Fp>\n\u003Caside class=\"my-4 rounded-lg border p-4 text-sm leading-relaxed not-prose border-brand-200 bg-brand-50 text-brand-950 theme-dark:text-gray-800\" role=\"note\">\u003Cdiv class=\"openapi-callout-body [&amp;_p:last-child]:mb-0 [&amp;_p]:mb-2\">Для получения более подробной информации, пожалуйста, обратитесь к \u003Ca href=\"https:\u002F\u002Foauth.net\u002F2\u002F\" target=\"_blank\" rel=\"noopener noreferrer\">официальной документации OAuth 2.0\u003C\u002Fa>.\u003C\u002Fdiv>\u003C\u002Faside>\u003Cp>\u003Cstrong>Authorization URL\u003C\u002Fstrong>: \u003Ccode>https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize\u003C\u002Fcode>\u003C\u002Fp>\n\u003Cp>\u003Cstrong>Token URL\u003C\u002Fstrong>: \u003Ccode>https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken\u003C\u002Fcode>\u003C\u002Fp>\n\u003Cp>\u003Cstrong>Scopes\u003C\u002Fstrong>:\u003C\u002Fp>\n\u003Cul>\n  \u003Cli>\u003Ccode>sms-scope\u003C\u002Fcode> открывает доступ к управлению номерами для услуги \"Прием SMS\" от Onlinesim;\u003C\u002Fli>\n  \u003Cli>\u003Ccode>rent-scope\u003C\u002Fcode> открывает доступ к аренде виртуальных телефонных номеров Onlinesim;\u003C\u002Fli>\n  \u003Cli>\u003Ccode>free-scope\u003C\u002Fcode> открывает доступ к использованию бесплатных номеров Onlinesim.\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Cp>Scope проверяется только там, где он нужен методу: \u003Ccode>sms-scope\u003C\u002Fcode> — getTariffs и getNumbersStats, \u003Ccode>rent-scope\u003C\u002Fcode> — методы аренды, \u003Ccode>free-scope\u003C\u002Fcode> — getFreeList. Остальные методы принимают любой действующий токен. Токен, выданный без \u003Ccode>scope\u003C\u002Fcode>, получает \u003Ccode>sms-scope\u003C\u002Fcode>.\u003C\u002Fp>\n\u003Cp>Access token живёт 2 месяца, refresh token — 4 месяца (\u003Ccode>expires_in\u003C\u002Fcode> в ответе с токеном — в секундах).\u003C\u002Fp>\n\u003Ch3>\u003Cstrong>Регистрация вашего приложения на нашем сервисе авторизации\u003C\u002Fstrong>\u003C\u002Fh3>\n\u003Col>\n  \u003Cli>Перейдите на \u003Ca href=\"\u002Foauth\">страницу OAuth\u003C\u002Fa>\u003C\u002Fli>\n  \u003Cli>\n    \u003Cp>Создайте новый клиент, указав:\u003C\u002Fp>\n    \u003Cul>\n      \u003Cli>\u003Ccode>Name\u003C\u002Fcode> - название приложения или любое другое название, которое Вы и Ваши пользователи будут ассоциировать с приложением;\u003C\u002Fli>\n      \u003Cli>\u003Ccode>Redirect URL\u003C\u002Fcode> - URL, на который будет перенаправлен клиент после авторизации и куда будет направлен код авторизации приложения;\u003C\u002Fli>\n      \u003Cli>\u003Ccode>Confidential\u003C\u002Fcode> - необзятально, отметье клиент как \u003Cem>Confidential\u003C\u002Fem>, если ваше приложение работает на сервере и может безопасно хранить \u003Cem>Client Secret\u003C\u002Fem>.\u003C\u002Fli>\n    \u003C\u002Ful>\n  \u003C\u002Fli>\n\u003C\u002Fol>\n\u003Cp>\u003Cimg src=\"\u002Fopenapi_docs\u002Fdocs\u002FCreateOAuthClient.png\" alt=\"Создание клиента\">\u003C\u002Fp>\n\u003Col start=\"3\">\n  \u003Cli>Нажмите \"Create\". Добавленное Вами приложение будет отображаться в списке клиентов.\u003C\u002Fli>\n\u003C\u002Fol>\n\u003Cp>\u003Cimg src=\"\u002Fopenapi_docs\u002Fdocs\u002FOAuthClient.png\" alt=\"Список клиентов\">\u003C\u002Fp>\n\u003Col start=\"4\">\n  \u003Cli>Сохраните \u003Ccode>Client ID\u003C\u002Fcode> и \u003Ccode>Secret\u003C\u002Fcode> в безопасном месте, далее они будут использоваться Вашим приложении для авторизации.\u003C\u002Fli>\n\u003C\u002Fol>\n\u003Cp>\u003Cspan id=\"AUTHCODE\">\u003C\u002Fspan>\u003C\u002Fp>\n\u003Ch3>OAuth 2.0. Authorization Сode Flow\u003C\u002Fh3>\n\u003Ch4>\u003Cstrong>Авторизация пользователя и получение токена\u003C\u002Fstrong>\u003C\u002Fh4>\n\u003Col>\n  \u003Cli>Авторизуйте клиент через GET запрос к \u003Ccode>https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize\u003C\u002Fcode> с параметрами \u003Ccode>client_id\u003C\u002Fcode>, \u003Ccode>redirect_uri\u003C\u002Fcode>, \u003Ccode>response_type\u003C\u002Fcode>, \u003Ccode>scope\u003C\u002Fcode>, \u003Ccode>state\u003C\u002Fcode>:\u003C\u002Fli>\n\u003C\u002Fol>\n\u003Ch5>Описание параметров\u003C\u002Fh5>\n\u003Ctable>\n  \u003Cthead>\n    \u003Ctr>\n      \u003Cth>Название параметра\u003C\u002Fth>\n      \u003Cth style=\"text-align:center\">Тип данных\u003C\u002Fth>\n      \u003Cth>Описание\u003C\u002Fth>\n    \u003C\u002Ftr>\n  \u003C\u002Fthead>\n  \u003Ctbody>\n    \u003Ctr>\n      \u003Ctd>client_id\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>\u003Ccode>Client ID\u003C\u002Fcode>, который был получен после регистрации приложения\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>redirect_uri\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Адрес на который будет перенаправлен клиент, после успешной авторизации, должен совпадать с \u003Ccode>Redirect URL\u003C\u002Fcode>, который Вы указали при регистрации приложения.\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>response_type\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Указать \u003Ccode>code\u003C\u002Fcode>\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>scope\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Права доступа, разрешение на которые запрашивает Ваше приложение у пользователя. Возможные варианты: \u003Ccode>sms-scope\u003C\u002Fcode>, \u003Ccode>rent-scope\u003C\u002Fcode>, \u003Ccode>free-scope\u003C\u002Fcode>. Можно указать несколько значений\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>state\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Случайная строка для защиты от CSRF (проверьте её после редиректа)\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>code_challenge\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Обязателен для клиента без отметки Confidential (PKCE): BASE64URL(SHA256(\u003Ccode>code_verifier\u003C\u002Fcode>))\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>code_challenge_method\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>\u003Ccode>S256\u003C\u002Fcode>\u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Col start=\"2\">\n  \u003Cli>После запроса к \u003Ccode>https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize\u003C\u002Fcode> пользователь из Вашего приложения будет перенаправлен на страницу авторизации, где ему необходимо указать логин пароль и, в случае успеха, авторизовать Ваше приложение для работы с данными пользователя в сервисе Onlinesim. Для этого ему необходимо будет нажать кнопку \u003Cem>\u003Ccode>Authorize\u003C\u002Fcode>\u003C\u002Fem>:\u003C\u002Fli>\n\u003C\u002Fol>\n\u003Cp>\u003Cimg src=\"\u002Fopenapi_docs\u002Fdocs\u002FOAuthRequest.png\" alt=\"OAuth запрос\">\u003C\u002Fp>\n\u003Caside class=\"my-4 rounded-lg border p-4 text-sm leading-relaxed not-prose border-brand-200 bg-brand-50 text-brand-950 theme-dark:text-gray-800\" role=\"note\">\u003Cdiv class=\"openapi-callout-body [&amp;_p:last-child]:mb-0 [&amp;_p]:mb-2\">На этом этапе Вы можете проверить параметр \u003Ccode>state\u003C\u002Fcode>\n, для подтверждения безопасного взаимодействия с сервисом авторизации\u003C\u002Fdiv>\u003C\u002Faside>\u003Col start=\"3\">\n  \u003Cli>В случае успешной авторизации пользователь будет перенаправлен по адресу \u003Ccode>redirect_uri\u003C\u002Fcode> с параметром \u003Ccode>code\u003C\u002Fcode>. Теперь Вы можете получить \u003Ccode>access token\u003C\u002Fcode>, для этого необходимо сделать POST запрос к \u003Ccode>https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken\u003C\u002Fcode>:\u003C\u002Fli>\n\u003C\u002Fol>\n\u003Ch5>Описание параметров\u003C\u002Fh5>\n\u003Ctable>\n  \u003Cthead>\n    \u003Ctr>\n      \u003Cth>Название параметра\u003C\u002Fth>\n      \u003Cth style=\"text-align:center\">Тип данных\u003C\u002Fth>\n      \u003Cth>Описание\u003C\u002Fth>\n    \u003C\u002Ftr>\n  \u003C\u002Fthead>\n  \u003Ctbody>\n    \u003Ctr>\n      \u003Ctd>grant_type\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Сценарий авторизации, для сценария Authorization Сode необходимо указать \u003Ccode>authorization_code\u003C\u002Fcode>\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>client_id\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>\u003Ccode>Client ID\u003C\u002Fcode>, который был получен после регистрации приложения\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>client_secret\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>\u003Ccode>Сlient_secret\u003C\u002Fcode>, который был получен после регистрации приложения\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>redirect_uri\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Адрес на который будет перенаправлен клиент, после успешной авторизации, должен совпадать с \u003Ccode>Redirect URL\u003C\u002Fcode>, который Вы указали при регистрации приложения\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>code\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Код авторизации, который был получен на предыдущем этапе\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>code_verifier\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Случайная строка, из которой сделан \u003Ccode>code_challenge\u003C\u002Fcode> (клиенты без отметки Confidential)\u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Caside class=\"my-4 rounded-lg border p-4 text-sm leading-relaxed not-prose border-red-200 bg-red-50 text-red-950 theme-dark:text-red-800\" role=\"note\">\u003Cdiv class=\"openapi-callout-body [&amp;_p:last-child]:mb-0 [&amp;_p]:mb-2\">Так как \u003Ccode>client_secret\u003C\u002Fcode>\n -  это приватный ключ, его крайне не рекомендуется хранить на frontend клиента. Для большей безопасности необходимо хранить его в бэкенде Вашего приложения. Для реализации сценария с авторизационным кодом нужно передать полученный frontend'ем код в backend Вашего сервиса, а уже он должен обратится в авторизационный сервис для получения токена.\u003C\u002Fdiv>\u003C\u002Faside>\u003Col start=\"4\">\n  \u003Cli>В результате успешного выполнения запроса к \u003Ccode>https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken\u003C\u002Fcode>, в ответ получите JSON, содержащий поля \u003Ccode>access_token\u003C\u002Fcode>, \u003Ccode>refresh_token\u003C\u002Fcode> и \u003Ccode>expires_in\u003C\u002Fcode>. Поле \u003Ccode>expires_in\u003C\u002Fcode> определяет количество секунд до истечения срока действия токена доступа, \u003Ccode>refresh_token\u003C\u002Fcode> используется для обновления токена доступа при истечении его срока действия.\u003C\u002Fli>\n\u003C\u002Fol>\n\u003Chr>\n\u003Ch4>\u003Cstrong>Авторизация запросов к API Onlinesim и обновление токена\u003C\u002Fstrong>\u003C\u002Fh4>\n\u003Cp>Во все запросы к API нужно добавлять заголовок \u003Cstrong>Authorization: Bearer \u003Cem>\u003Ccode>access_token\u003C\u002Fcode>\u003C\u002Fem>\u003C\u002Fstrong>.\nЕсли в ответ на ваш запрос пришел \u003Ccode>ERROR_WRONG_KEY\u003C\u002Fcode> (HTTP 456), Вам необходимо обновить токен или получить новый.\u003C\u002Fp>\n\u003Cpre data-lang=\"json\">\u003Ccode class=\"code-hl code-ln\" style=\"--ln-digits:1\">\u003Cspan class=\"line\">\u003Cspan class=\"tok-punct\">{\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">  \u003Cspan class=\"tok-key\">&quot;response&quot;\u003C\u002Fspan>\u003Cspan class=\"tok-punct\">:\u003C\u002Fspan> \u003Cspan class=\"tok-string\">&quot;ERROR_WRONG_KEY&quot;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan class=\"tok-punct\">}\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cp>Для обновления токена необходимо сделать POST запрос к \u003Ccode>https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken\u003C\u002Fcode> с параметрами \u003Ccode>grant_type\u003C\u002Fcode>, \u003Ccode>client_id\u003C\u002Fcode>, \u003Ccode>client_secret\u003C\u002Fcode> и \u003Ccode>refresh_token\u003C\u002Fcode>. Для поля \u003Ccode>refresh_token\u003C\u002Fcode> необходимо использовать значение, которое было получено в шаге 4.\u003C\u002Fp>\n\u003Ch5>Описание параметров\u003C\u002Fh5>\n\u003Ctable>\n  \u003Cthead>\n    \u003Ctr>\n      \u003Cth>Название параметра\u003C\u002Fth>\n      \u003Cth style=\"text-align:center\">Тип данных\u003C\u002Fth>\n      \u003Cth>Описание\u003C\u002Fth>\n    \u003C\u002Ftr>\n  \u003C\u002Fthead>\n  \u003Ctbody>\n    \u003Ctr>\n      \u003Ctd>grant_type\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Необходимо указать \u003Ccode>refresh_token\u003C\u002Fcode>\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>client_id\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>\u003Ccode>client ID\u003C\u002Fcode>, который Вы получили при регистрации приложения\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>client_secret\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>\u003Ccode>client_secret\u003C\u002Fcode>, который был получен при регистрации приложения\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>refresh_token\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>\u003Ccode>refresh_token\u003C\u002Fcode> был получен вместе с \u003Ccode>access_token\u003C\u002Fcode>. Имеет гораздо большее время жизни и используется для обновления \u003Ccode>access_token\u003C\u002Fcode>\u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Cp>\u003Cspan id=\"IMPLICIT\">\u003C\u002Fspan>\u003C\u002Fp>\n\u003Ch3>OAuth 2.0. Implicit flow\u003C\u002Fh3>\n\u003Ch4>\u003Cstrong>Авторизация пользователя и получение токена\u003C\u002Fstrong>\u003C\u002Fh4>\n\u003Col>\n  \u003Cli>Авторизуйте клиент через GET запрос к \u003Ccode>https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize\u003C\u002Fcode> с параметрами \u003Ccode>client_id\u003C\u002Fcode>, \u003Ccode>redirect_uri\u003C\u002Fcode>, \u003Ccode>response_type\u003C\u002Fcode>, \u003Ccode>scope\u003C\u002Fcode>, \u003Ccode>state\u003C\u002Fcode>:\u003C\u002Fli>\n\u003C\u002Fol>\n\u003Ch5>Описание параметров\u003C\u002Fh5>\n\u003Ctable>\n  \u003Cthead>\n    \u003Ctr>\n      \u003Cth>Название параметра\u003C\u002Fth>\n      \u003Cth style=\"text-align:center\">Тип данных\u003C\u002Fth>\n      \u003Cth>Описание\u003C\u002Fth>\n    \u003C\u002Ftr>\n  \u003C\u002Fthead>\n  \u003Ctbody>\n    \u003Ctr>\n      \u003Ctd>client_id\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>\u003Ccode>Client ID\u003C\u002Fcode>, который был получен при регистрации приложения\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>redirect_uri\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Адрес на который будет перенаправлен клиент, после успешной авторизации, должен совпадать с \u003Ccode>Redirect URL\u003C\u002Fcode>, который Вы указали при добавлении приложения.\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>response_type\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Используйте \u003Ccode>token\u003C\u002Fcode> в качестве значения\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>scope\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Права доступа, разрешение на которые запрашивает Ваше приложение у пользователя. Возможные варианты: \u003Ccode>sms-scope\u003C\u002Fcode>, \u003Ccode>rent-scope\u003C\u002Fcode>, \u003Ccode>free-scope\u003C\u002Fcode>. Можно указать несколько значений\u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003Ctr>\n      \u003Ctd>state\u003C\u002Ftd>\n      \u003Ctd style=\"text-align:center\">STRING\u003C\u002Ftd>\n      \u003Ctd>Случайная строка для защиты от CSRF (проверьте её после редиректа)\u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003Col start=\"2\">\n  \u003Cli>После запроса к \u003Ccode>https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize\u003C\u002Fcode>, пользователь из Вашего приложения будет перенаправлен на страницу авторизации, где ему необходимо указать логин пароль и, в случае успеха, авторизовать Ваше приложение для работы с данными пользователя в сервисе Onlinesim. Для этого ему необходимо будет нажать кнопку \u003Cem>\u003Ccode>Authorize\u003C\u002Fcode>\u003C\u002Fem>:\u003C\u002Fli>\n\u003C\u002Fol>\n\u003Cp>\u003Cimg src=\"\u002Fopenapi_docs\u002Fdocs\u002FOAuthRequest.png\" alt=\"OAuth запрос\">\u003C\u002Fp>\n\u003Caside class=\"my-4 rounded-lg border p-4 text-sm leading-relaxed not-prose border-brand-200 bg-brand-50 text-brand-950 theme-dark:text-gray-800\" role=\"note\">\u003Cdiv class=\"openapi-callout-body [&amp;_p:last-child]:mb-0 [&amp;_p]:mb-2\">На этом этапе Вы можете проверить параметр \u003Ccode>state\u003C\u002Fcode>\n, для подтверждения безопасного взаимодействия с сервисом авторизации\u003C\u002Fdiv>\u003C\u002Faside>\u003Col start=\"3\">\n  \u003Cli>В случае успешной авторизации пользователь будет перенаправлен по адрес \u003Ccode>redirect_uri\u003C\u002Fcode> с параметром \u003Ccode>access_token\u003C\u002Fcode>. Это и есть необходимый токен для авторизации в API Onlinesim.\u003C\u002Fli>\n\u003C\u002Fol>\n\u003Chr>\n\u003Ch3>\u003Cstrong>Авторизация запросов к API Onlinesim\u003C\u002Fstrong>\u003C\u002Fh3>\n\u003Cp>Во все запросы к API нужно добавлять заголовок \u003Cstrong>Authorization: Bearer \u003Cem>\u003Ccode>access_token\u003C\u002Fcode>\u003C\u002Fem>\u003C\u002Fstrong>.\nЕсли в ответ на ваш запрос пришел \u003Ccode>ERROR_WRONG_KEY\u003C\u002Fcode> (HTTP 456), Вам необходимо получить новый токен: Implicit flow не выдаёт refresh token.\u003C\u002Fp>\n\u003Cpre data-lang=\"json\">\u003Ccode class=\"code-hl code-ln\" style=\"--ln-digits:1\">\u003Cspan class=\"line\">\u003Cspan class=\"tok-punct\">{\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">  \u003Cspan class=\"tok-key\">&quot;response&quot;\u003C\u002Fspan>\u003Cspan class=\"tok-punct\">:\u003C\u002Fspan> \u003Cspan class=\"tok-string\">&quot;ERROR_WRONG_KEY&quot;\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan class=\"tok-punct\">}\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>","\u003Cspan id=\"OAUTH\">\u003C\u002Fspan>\n### OAuth 2.0\nПротокол OAuth 2.0 поддерживает несколько сценариев авторизации, для работы с нашим API можно использовать сценарии Authorization Code Flow или Implicit Flow.\n\n::: info\nДля получения более подробной информации, пожалуйста, обратитесь к [официальной документации OAuth 2.0](https:\u002F\u002Foauth.net\u002F2\u002F).\n:::\n\n**Authorization URL**: `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize`\n\n**Token URL**: `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken`\n\n**Scopes**:\n\n  - `sms-scope` открывает доступ к управлению номерами для услуги \"Прием SMS\" от Onlinesim;\n  \n  - `rent-scope` открывает доступ к аренде виртуальных телефонных номеров Onlinesim;\n  \n  - `free-scope` открывает доступ к использованию бесплатных номеров Onlinesim.\n\nScope проверяется только там, где он нужен методу: `sms-scope` — getTariffs и getNumbersStats, `rent-scope` — методы аренды, `free-scope` — getFreeList. Остальные методы принимают любой действующий токен. Токен, выданный без `scope`, получает `sms-scope`.\n\nAccess token живёт 2 месяца, refresh token — 4 месяца (`expires_in` в ответе с токеном — в секундах).\n\n### **Регистрация вашего приложения на нашем сервисе авторизации**\n\n1. Перейдите на [страницу OAuth](https:\u002F\u002Fonlinesim.io\u002Foauth)\n2. Создайте новый клиент, указав:\n      * `Name` - название приложения или любое другое название, которое Вы и Ваши пользователи будут ассоциировать с приложением;\n      * `Redirect URL` - URL, на который будет перенаправлен клиент после авторизации и куда будет направлен код авторизации приложения;\n      * `Confidential` - необзятально, отметье клиент как *Confidential*, если ваше приложение работает на сервере и может безопасно хранить *Client Secret*.\n\n![Создание клиента](\u002Fdocs\u002FCreateOAuthClient.png)\n\n3. Нажмите \"Create\". Добавленное Вами приложение будет отображаться в списке клиентов.\n\n![Список клиентов](\u002Fdocs\u002FOAuthClient.png)\n\n4. Сохраните `Client ID` и `Secret` в безопасном месте, далее они будут использоваться Вашим приложении для авторизации.\n\n\u003Cspan id=\"AUTHCODE\">\u003C\u002Fspan>\n### OAuth 2.0. Authorization Сode Flow\n\n#### **Авторизация пользователя и получение токена**\n\n1. Авторизуйте клиент через GET запрос к `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize` с параметрами `client_id`, `redirect_uri`, `response_type`, `scope`, `state`:\n\n##### Описание параметров\n\n  Название параметра | Тип данных | Описание\n  -------------------|:----------:|---------\n  client_id | STRING | `Client ID`, который был получен после регистрации приложения\n  redirect_uri | STRING | Адрес на который будет перенаправлен клиент, после успешной авторизации, должен совпадать с `Redirect URL`, который Вы указали при регистрации приложения.\n  response_type | STRING | Указать `code`\n  scope | STRING | Права доступа, разрешение на которые запрашивает Ваше приложение у пользователя. Возможные варианты: `sms-scope`, `rent-scope`, `free-scope`. Можно указать несколько значений\n  state | STRING | Случайная строка для защиты от CSRF (проверьте её после редиректа)\n  code_challenge | STRING | Обязателен для клиента без отметки Confidential (PKCE): BASE64URL(SHA256(`code_verifier`))\n  code_challenge_method | STRING | `S256`\n\n2. После запроса к `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize` пользователь из Вашего приложения будет перенаправлен на страницу авторизации, где ему необходимо указать логин пароль и, в случае успеха, авторизовать Ваше приложение для работы с данными пользователя в сервисе Onlinesim. Для этого ему необходимо будет нажать кнопку *`Authorize`*:\n\n![OAuth запрос](\u002Fdocs\u002FOAuthRequest.png)\n\n::: info\nНа этом этапе Вы можете проверить параметр `state`, для подтверждения безопасного взаимодействия с сервисом авторизации\n:::\n\n3. В случае успешной авторизации пользователь будет перенаправлен по адресу `redirect_uri` с параметром `code`. Теперь Вы можете получить `access token`, для этого необходимо сделать POST запрос к `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken`:\n\n##### Описание параметров\n\n  Название параметра | Тип данных | Описание\n  ---------|:--------:|---------\n  grant_type | STRING | Сценарий авторизации, для сценария Authorization Сode необходимо указать `authorization_code`\n  client_id | STRING | `Client ID`, который был получен после регистрации приложения\n  client_secret | STRING |`Сlient_secret`, который был получен после регистрации приложения\n  redirect_uri | STRING | Адрес на который будет перенаправлен клиент, после успешной авторизации, должен совпадать с `Redirect URL`, который Вы указали при регистрации приложения\n  code | STRING | Код авторизации, который был получен на предыдущем этапе\n  code_verifier | STRING | Случайная строка, из которой сделан `code_challenge` (клиенты без отметки Confidential)\n\n\n::: danger\n  \nТак как `client_secret` -  это приватный ключ, его крайне не рекомендуется хранить на frontend клиента. Для большей безопасности необходимо хранить его в бэкенде Вашего приложения. Для реализации сценария с авторизационным кодом нужно передать полученный frontend'ем код в backend Вашего сервиса, а уже он должен обратится в авторизационный сервис для получения токена.\n:::\n\n4. В результате успешного выполнения запроса к `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken`, в ответ получите JSON, содержащий поля `access_token`, `refresh_token` и `expires_in`. Поле `expires_in` определяет количество секунд до истечения срока действия токена доступа, `refresh_token` используется для обновления токена доступа при истечении его срока действия.\n\n---\n\n#### **Авторизация запросов к API Onlinesim и обновление токена**\n\nВо все запросы к API нужно добавлять заголовок **Authorization: Bearer *`access_token`***.\nЕсли в ответ на ваш запрос пришел `ERROR_WRONG_KEY` (HTTP 456), Вам необходимо обновить токен или получить новый.\n\n  ```json\n  {\n    \"response\": \"ERROR_WRONG_KEY\"\n  }\n  ```\n\nДля обновления токена необходимо сделать POST запрос к `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken` с параметрами `grant_type`, `client_id`, `client_secret` и `refresh_token`. Для поля `refresh_token` необходимо использовать значение, которое было получено в шаге 4.\n\n##### Описание параметров\n\n  Название параметра | Тип данных | Описание\n  ---------|:--------:|---------\n  grant_type | STRING | Необходимо указать `refresh_token`\n  client_id | STRING | `client ID`, который Вы получили при регистрации приложения\n  client_secret | STRING | `client_secret`, который был получен при регистрации приложения\n  refresh_token | STRING | `refresh_token` был получен вместе с `access_token`. Имеет гораздо большее время жизни и используется для обновления `access_token`\n\n\n\u003Cspan id=\"IMPLICIT\">\u003C\u002Fspan>\n### OAuth 2.0. Implicit flow\n\n#### **Авторизация пользователя и получение токена**\n1. Авторизуйте клиент через GET запрос к `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize` с параметрами `client_id`, `redirect_uri`, `response_type`, `scope`, `state`:\n\n##### Описание параметров\n\n  Название параметра | Тип данных | Описание\n  ---------|:--------:|---------\n  client_id | STRING | `Client ID`, который был получен при регистрации приложения\n  redirect_uri | STRING | Адрес на который будет перенаправлен клиент, после успешной авторизации, должен совпадать с `Redirect URL`, который Вы указали при добавлении приложения.\n  response_type | STRING | Используйте `token` в качестве значения\n  scope | STRING | Права доступа, разрешение на которые запрашивает Ваше приложение у пользователя. Возможные варианты: `sms-scope`, `rent-scope`, `free-scope`. Можно указать несколько значений\n  state | STRING | Случайная строка для защиты от CSRF (проверьте её после редиректа)\n\n2. После запроса к `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize`, пользователь из Вашего приложения будет перенаправлен на страницу авторизации, где ему необходимо указать логин пароль и, в случае успеха, авторизовать Ваше приложение для работы с данными пользователя в сервисе Onlinesim. Для этого ему необходимо будет нажать кнопку *`Authorize`*:\n\n![OAuth запрос](\u002Fdocs\u002FOAuthRequest.png)\n\n::: info\nНа этом этапе Вы можете проверить параметр `state`, для подтверждения безопасного взаимодействия с сервисом авторизации\n:::\n\n3. В случае успешной авторизации пользователь будет перенаправлен по адрес `redirect_uri` с параметром `access_token`. Это и есть необходимый токен для авторизации в API Onlinesim.\n\n---\n\n### **Авторизация запросов к API Onlinesim**\n\nВо все запросы к API нужно добавлять заголовок **Authorization: Bearer *`access_token`***.\nЕсли в ответ на ваш запрос пришел `ERROR_WRONG_KEY` (HTTP 456), Вам необходимо получить новый токен: Implicit flow не выдаёт refresh token.\n\n  ```json\n  {\n    \"response\": \"ERROR_WRONG_KEY\"\n  }\n  ```\n","\u003Cspan id=\"OAUTH\">\u003C\u002Fspan>\n### OAuth 2.0\nDas OAuth 2.0-Protokoll unterstützt mehrere Autorisierungsszenarien. Für die Arbeit mit unserer API können Sie die Szenarien Authorization Code Flow oder Implicit Flow verwenden.\n\n::: info\nFür weitere Informationen wenden Sie sich bitte an die [offizielle OAuth 2.0-Dokumentation](https:\u002F\u002Foauth.net\u002F2\u002F).\n:::\n\n**Authorization URL**: `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize`\n\n**Token URL**: `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken`\n\n**Scopes**:\n\n  - `sms-scope` gewährt Zugriff auf die Verwaltung von Nummern für den Dienst \"SMS-Empfang\" von Onlinesim;\n  \n  - `rent-scope` gewährt Zugriff auf die Vermietung virtueller Telefonnummern von Onlinesim;\n  \n  - `free-scope` gewährt Zugriff auf die Verwendung kostenloser Nummern von Onlinesim.\n\nEin Scope wird nur dort geprüft, wo die Methode ihn braucht: `sms-scope` — getTariffs und getNumbersStats, `rent-scope` — die Mietmethoden, `free-scope` — getFreeList. Die übrigen Methoden akzeptieren jedes gültige Token. Ein ohne `scope` ausgestelltes Token erhält `sms-scope`.\n\nEin Access Token gilt 2 Monate, ein Refresh Token 4 Monate (`expires_in` in der Token-Antwort ist in Sekunden).\n\n### **Registrierung Ihrer Anwendung auf unserem Autorisierungsdienst**\n\n1. Gehen Sie zur [OAuth-Seite](https:\u002F\u002Fonlinesim.io\u002Foauth)\n2. Erstellen Sie einen neuen Client und geben Sie an:\n      * `Name` - Name der Anwendung oder ein anderer Name, den Sie und Ihre Benutzer mit der Anwendung assoziieren werden;\n      * `Redirect URL` - URL, an die der Client nach der Autorisierung weitergeleitet wird und wohin der Autorisierungscode der Anwendung gesendet wird;\n      * `Confidential` - optional, markieren Sie den Client als *Confidential*, wenn Ihre Anwendung auf einem Server läuft und den *Client Secret* sicher speichern kann.\n\n![Client erstellen](\u002Fdocs\u002FCreateOAuthClient.png)\n\n3. Klicken Sie auf \"Create\". Ihre hinzugefügte Anwendung wird in der Liste der Clients angezeigt.\n\n![Client-Liste](\u002Fdocs\u002FOAuthClient.png)\n\n4. Speichern Sie `Client ID` und `Secret` an einem sicheren Ort, sie werden von Ihrer Anwendung für die Autorisierung verwendet.\n\n\u003Cspan id=\"AUTHCODE\">\u003C\u002Fspan>\n### OAuth 2.0. Authorization Code Flow\n\n#### **Benutzerautorisierung und Token-Erhaltung**\n\n1. Autorisieren Sie den Client über eine GET-Anfrage an `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize` mit den Parametern `client_id`, `redirect_uri`, `response_type`, `scope`, `state`:\n\n##### Parameterbeschreibung\n\n  Parametername | Datentyp | Beschreibung\n  -------------------|:----------:|---------\n  client_id | STRING | `Client ID`, der nach der Registrierung der Anwendung erhalten wurde\n  redirect_uri | STRING | Adresse, an die der Client nach erfolgreicher Autorisierung weitergeleitet wird, muss mit der `Redirect URL` übereinstimmen, die Sie bei der Registrierung der Anwendung angegeben haben.\n  response_type | STRING | Geben Sie `code` an\n  scope | STRING | Zugriffsrechte, deren Genehmigung Ihre Anwendung vom Benutzer anfordert. Mögliche Optionen: `sms-scope`, `rent-scope`, `free-scope`. Mehrere Werte können angegeben werden\n  state | STRING | Zufällige Zeichenfolge zum Schutz vor CSRF (überprüfen Sie sie nach der Weiterleitung)\n  code_challenge | STRING | Pflicht für einen nicht als Confidential markierten Client (PKCE): BASE64URL(SHA256(`code_verifier`))\n  code_challenge_method | STRING | `S256`\n\n2. Nach der Anfrage an `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize` wird der Benutzer aus Ihrer Anwendung zur Autorisierungsseite weitergeleitet, wo er Benutzername und Passwort eingeben muss und bei Erfolg Ihre Anwendung für die Arbeit mit den Benutzerdaten im Onlinesim-Dienst autorisieren muss. Dazu muss er auf die Schaltfläche *`Authorize`* klicken:\n\n![OAuth-Anfrage](\u002Fdocs\u002FOAuthRequest.png)\n\n::: info\nAuf dieser Stufe können Sie den Parameter `state` überprüfen, um die sichere Interaktion mit dem Autorisierungsdienst zu bestätigen\n:::\n\n3. Bei erfolgreicher Autorisierung wird der Benutzer an die Adresse `redirect_uri` mit dem Parameter `code` weitergeleitet. Jetzt können Sie ein `access token` erhalten, dazu müssen Sie eine POST-Anfrage an `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken` stellen:\n\n##### Parameterbeschreibung\n\n  Parametername | Datentyp | Beschreibung\n  ---------|:--------:|---------\n  grant_type | STRING | Autorisierungsszenario, für das Szenario Authorization Code müssen Sie `authorization_code` angeben\n  client_id | STRING | `Client ID`, der nach der Registrierung der Anwendung erhalten wurde\n  client_secret | STRING |`Client_secret`, der nach der Registrierung der Anwendung erhalten wurde\n  redirect_uri | STRING | Adresse, an die der Client nach erfolgreicher Autorisierung weitergeleitet wird, muss mit der `Redirect URL` übereinstimmen, die Sie bei der Registrierung der Anwendung angegeben haben\n  code | STRING | Autorisierungscode, der in der vorherigen Stufe erhalten wurde\n  code_verifier | STRING | Die Zufallszeichenfolge, aus der `code_challenge` erzeugt wurde (nicht als Confidential markierte Clients)\n\n::: danger\n\nDa `client_secret` ein privater Schlüssel ist, wird nicht empfohlen, ihn im Frontend des Clients zu speichern. Für mehr Sicherheit muss er im Backend Ihrer Anwendung gespeichert werden. Um das Szenario mit dem Autorisierungscode zu implementieren, muss der vom Frontend erhaltene Code an das Backend Ihres Dienstes übergeben werden, und dieses muss sich dann an den Autorisierungsdienst wenden, um das Token zu erhalten.\n:::\n\n4. Als Ergebnis einer erfolgreichen Anfrage an `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken` erhalten Sie eine JSON-Antwort, die die Felder `access_token`, `refresh_token` und `expires_in` enthält. Das Feld `expires_in` bestimmt die Anzahl der Sekunden bis zum Ablauf des Zugriffstokens, `refresh_token` wird verwendet, um das Zugriffstoken bei Ablauf zu aktualisieren.\n\n---\n\n#### **Autorisierung von Anfragen an die Onlinesim API und Token-Aktualisierung**\n\nZu allen Anfragen an die API muss der Header **Authorization: Bearer *`access_token`*** hinzugefügt werden.\nWenn als Antwort auf Ihre Anfrage `ERROR_WRONG_KEY` (HTTP 456) kam, müssen Sie das Token aktualisieren oder ein neues erhalten.\n\n  ```json\n  {\n    \"response\": \"ERROR_WRONG_KEY\"\n  }\n  ```\n\nUm das Token zu aktualisieren, müssen Sie eine POST-Anfrage an `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken` mit den Parametern `grant_type`, `client_id`, `client_secret` und `refresh_token` stellen. Für das Feld `refresh_token` muss der Wert verwendet werden, der in Schritt 4 erhalten wurde.\n\n##### Parameterbeschreibung\n\n  Parametername | Datentyp | Beschreibung\n  ---------|:--------:|---------\n  grant_type | STRING | Sie müssen `refresh_token` angeben\n  client_id | STRING | `client ID`, den Sie bei der Registrierung der Anwendung erhalten haben\n  client_secret | STRING | `client_secret`, der bei der Registrierung der Anwendung erhalten wurde\n  refresh_token | STRING | `refresh_token` wurde zusammen mit `access_token` erhalten. Hat eine viel längere Lebensdauer und wird verwendet, um `access_token` zu aktualisieren\n\n\n\u003Cspan id=\"IMPLICIT\">\u003C\u002Fspan>\n### OAuth 2.0. Implicit Flow\n\n#### **Benutzerautorisierung und Token-Erhaltung**\n1. Autorisieren Sie den Client über eine GET-Anfrage an `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize` mit den Parametern `client_id`, `redirect_uri`, `response_type`, `scope`, `state`:\n\n##### Parameterbeschreibung\n\n  Parametername | Datentyp | Beschreibung\n  ---------|:--------:|---------\n  client_id | STRING | `Client ID`, der bei der Registrierung der Anwendung erhalten wurde\n  redirect_uri | STRING | Adresse, an die der Client nach erfolgreicher Autorisierung weitergeleitet wird, muss mit der `Redirect URL` übereinstimmen, die Sie beim Hinzufügen der Anwendung angegeben haben.\n  response_type | STRING | Verwenden Sie `token` als Wert\n  scope | STRING | Zugriffsrechte, deren Genehmigung Ihre Anwendung vom Benutzer anfordert. Mögliche Optionen: `sms-scope`, `rent-scope`, `free-scope`. Mehrere Werte können angegeben werden\n  state | STRING | Zufällige Zeichenfolge zum Schutz vor CSRF (überprüfen Sie sie nach der Weiterleitung)\n\n2. Nach der Anfrage an `https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize` wird der Benutzer aus Ihrer Anwendung zur Autorisierungsseite weitergeleitet, wo er Benutzername und Passwort eingeben muss und bei Erfolg Ihre Anwendung für die Arbeit mit den Benutzerdaten im Onlinesim-Dienst autorisieren muss. Dazu muss er auf die Schaltfläche *`Authorize`* klicken:\n\n![OAuth-Anfrage](\u002Fdocs\u002FOAuthRequest.png)\n\n::: info\nAuf dieser Stufe können Sie den Parameter `state` überprüfen, um die sichere Interaktion mit dem Autorisierungsdienst zu bestätigen\n:::\n\n3. Bei erfolgreicher Autorisierung wird der Benutzer an die Adresse `redirect_uri` mit dem Parameter `access_token` weitergeleitet. Dies ist das erforderliche Token für die Autorisierung in der Onlinesim API.\n\n---\n\n### **Autorisierung von Anfragen an die Onlinesim API**\n\nZu allen Anfragen an die API muss der Header **Authorization: Bearer *`access_token`*** hinzugefügt werden.\nWenn als Antwort auf Ihre Anfrage `ERROR_WRONG_KEY` (HTTP 456) kam, müssen Sie ein neues Token erhalten: der Implicit Flow liefert kein Refresh Token.\n\n  ```json\n  {\n    \"response\": \"ERROR_WRONG_KEY\"\n  }\n  ```\n",{"implicit":436,"authorizationCode":442},{"authorizationUrl":437,"scopes":438},"https:\u002F\u002Fonlinesim.io\u002Foauth\u002Fauthorize",{"sms-scope":439,"rent-scope":440,"free-scope":441},"grants access to manage numbers for the SMS receiving service from Onlinesim","grants access to renting phone numbers from Onlinesim","grants access to using Onlinesim free numbers",{"authorizationUrl":437,"tokenUrl":443,"refreshUrl":443,"scopes":444},"https:\u002F\u002Fonlinesim.io\u002Foauth\u002Ftoken",{"sms-scope":439,"rent-scope":440,"free-scope":441},{"parameters":446,"requestBody":450,"responses":473},[447],{"name":187,"in":188,"description":189,"x-description-ru":190,"x-description-de":191,"required":55,"schema":448},{"type":193,"enum":449,"example":5},[195,37,36,5,196],{"required":198,"content":451},{"application\u002Fjson":452},{"schema":453},{"required":454,"properties":455,"type":257},[54],{"profile":456},{"description":205,"x-description-ru":206,"x-description-de":207,"properties":457,"type":257},{"webhook_url":458,"number_country":460,"number_reject":461,"name":467,"username":468,"email":469,"password":470,"password_confirmation":471,"old_password":472},{"description":210,"x-description-ru":211,"x-description-de":212,"type":459,"format":215,"example":216},[193,214],{"description":218,"x-description-ru":219,"x-description-de":220,"type":221,"example":222},{"description":224,"x-description-ru":225,"x-description-de":226,"oneOf":462},[463,465],{"type":229,"items":464},{"type":193},{"type":193,"enum":466},[214],{"description":234,"x-description-ru":235,"x-description-de":236,"type":193},{"description":238,"x-description-ru":239,"x-description-de":240,"type":193},{"description":242,"x-description-ru":243,"x-description-de":244,"type":193},{"description":246,"x-description-ru":247,"x-description-de":248,"type":193},{"description":250,"x-description-ru":251,"x-description-de":252,"type":193},{"description":254,"x-description-ru":255,"x-description-de":256,"type":193},{"200":474,"429":550,"456":560},{"description":260,"x-description-ru":261,"x-description-de":262,"content":475},{"application\u002Fjson":476},{"schema":477,"examples":543},{"oneOf":478},[479,530,534,539],{"required":480,"properties":481,"type":257},[269,270],{"response":482,"user":484},{"type":193,"enum":483,"example":274},[274],{"description":276,"x-description-ru":277,"x-description-de":278,"properties":485,"type":257},{"id":486,"hash_id":487,"name":489,"username":491,"email":493,"email_verified_at":495,"apikey":497,"api_access":498,"locale":503,"currency":504,"number_country":505,"number_reject":507,"number_region":513,"webhook_url":515,"number":517,"country":519,"is_api":521,"active":522,"block":523,"disable":524,"verify":525,"ugroup":526,"first_login":527,"is_project_subscription":528,"created_at":529},{"type":221,"example":281},{"type":488},[193,214],{"type":490,"example":286},[193,214],{"type":492},[193,214],{"type":494,"example":291},[193,214],{"type":496},[193,214],{"type":193},{"description":296,"x-description-ru":297,"x-description-de":298,"oneOf":499},[500,501],{"type":301},{"type":257,"additionalProperties":502},{"type":193},{"type":193,"example":5},{"type":193,"example":306},{"description":218,"x-description-ru":219,"x-description-de":220,"type":506,"example":222},[221,214],{"description":310,"x-description-ru":311,"x-description-de":312,"oneOf":508},[509,511,512],{"type":229,"items":510},{"type":193},{"type":257},{"type":214},{"description":319,"x-description-ru":320,"x-description-de":321,"type":514},[221,214],{"description":324,"x-description-ru":325,"x-description-de":326,"type":516},[193,214],{"type":518},[221,214],{"type":520},[193,214],{"type":301},{"type":193},{"type":221},{"type":301},{"type":221},{"type":221},{"type":301},{"type":301},{"type":193},{"description":342,"x-description-ru":343,"x-description-de":344,"required":531,"properties":532,"type":257},[269],{"response":533},{"type":257,"additionalProperties":198},{"required":535,"properties":536,"type":257},[269],{"response":537},{"type":193,"enum":538},[353,354],{"required":540,"properties":541,"type":257,"additionalProperties":198},[269],{"response":542},{"description":359,"x-description-ru":360,"x-description-de":361,"type":193},{"Validation error":544,"ERROR_PARAMS":548},{"summary":364,"x-summary-ru":365,"x-summary-de":366,"value":545},{"response":546},{"webhook_url":547},[370],{"summary":372,"x-summary-ru":373,"x-summary-de":374,"value":549},{"response":353},{"description":377,"x-description-ru":378,"x-description-de":379,"content":551},{"application\u002Fjson":552},{"schema":553,"examples":557},{"required":554,"properties":555,"type":257,"additionalProperties":198},[269],{"response":556},{"description":359,"x-description-ru":360,"x-description-de":361,"type":193},{"Rate limit":558},{"summary":388,"x-summary-ru":389,"x-summary-de":390,"value":559},{"response":392},{"description":394,"x-description-ru":395,"x-description-de":396,"content":561},{"application\u002Fjson":562},{"schema":563,"examples":567},{"required":564,"properties":565,"type":257,"additionalProperties":198},[269],{"response":566},{"description":359,"x-description-ru":360,"x-description-de":361,"type":193},{"Invalid key":568},{"summary":405,"x-summary-ru":406,"x-summary-de":407,"value":569},{"response":409},{"operationKey":175,"method":176,"urlPath":72,"isWebhook":55,"isInboundWebhook":55,"servers":571,"availableAuthMethods":575,"apiKeyAuth":576,"oauthConfigs":577,"prepared":589,"locale":36,"specName":8,"path":70},[572],{"url":573,"description":574},"https:\u002F\u002Fonlinesim.io","Onlinesim server",[423,429,431],{"in":188,"name":423},[578,584],{"schemeName":579,"flowType":580,"flow":581,"authorizationUrl":437,"tokenUrl":443,"refreshUrl":443,"scopes":583},"OAuth2","authorizationCode",{"authorizationUrl":437,"tokenUrl":443,"refreshUrl":443,"scopes":582},{"sms-scope":439,"rent-scope":440,"free-scope":441},{"sms-scope":439,"rent-scope":440,"free-scope":441},{"schemeName":579,"flowType":585,"flow":586,"authorizationUrl":437,"scopes":588},"implicit",{"authorizationUrl":437,"scopes":587},{"sms-scope":439,"rent-scope":440,"free-scope":441},{"sms-scope":439,"rent-scope":440,"free-scope":441},{"codeParams":590,"requestBody":597},{"method":176,"url":72,"baseUrl":573,"contentType":591,"params":592},"application\u002Fjson",[593,594],{"in":188,"name":187,"value":5,"type":193,"required":55},{"in":595,"name":54,"value":596,"type":257,"required":198},"body","file.jpg",{"required":198,"contentTypes":598,"activeContentType":591,"byContentType":599},[591],{"application\u002Fjson":600},{},1795170447775]