Přihlášení přes Seznam – Seznam pro vývojáře

Scopes

Když třetí strana v rámci Přihlášení přes Seznam přesměrovává uživatele na přihlašovací obrazovku, kromě své identifikace (client_id) musí také specifikovat, o která uživatelská data má zájem. K tomu slouží parametr scope. V něm je nutné zadat jedno či více klíčových slov (oddělených čárkou); uživatel má následně možnost některé tyto scopes odmítnout.

Podle toho, které scopes byly uživatelem odsouhlaseny, pak následné volání /api/v1/user vrátí různá data.

identity

Scope identity je povinný a uživatel jej nesmí odmítnout. Díky němu budou v odpovědi na /api/v1/user tyto položky:

oauth_user_id je unikátní trvalý identifikátor uživatelského účtu
email je e-mailová adresa, pokud ji uživatel má – jinak null
firstname je křestní jméno, pokud jej uživatel vyplnil
lastname je příjmení, pokud jej uživatel vyplnil
advert_user_id je identifikátor uživatele pro použití v reklamních skriptech Seznamu

contact-phone

Přidáním hodnoty contact-phone po uživateli vyžadujeme hodnotu jeho kontaktního telefonního čísla. V odpovědi na /api/v1/user pak přibude:

contact_phone (jen pokud uživatel kontaktní telefon nastavil a ověřil, jinak null)

avatar

Přidáním hodnoty avatar po uživateli vyžadujeme jeho profilový obrázek. V odpovědi na /api/v1/user pak přibude:

avatar_url – adresa k obrázku

Relevantní URL bude vráceno i pro ty uživatele, kteří si žádný obrázek nenastavili. V tomto případě bude obsahovat automaticky generovaný obrázek s iniciálami uživatele (ve formátu SVG). Rozměry obrázku lze ve všech případech konkretizovat zadáním čísla za lomítko na konec URL, např. ${avatar_url}/64

adulthood

Přidáním hodnoty adulthood vyžadujeme předání informace o zletilosti uživatele. V odpovědi na /api/v1/user pak přibude:

adulthood – hodnota true/false, odpovídající zletilosti uživatele

Hodnota true se vrací pro uživatele, kteří mají nastavené a ověřené datum narození, v den přihlášení staré alespoň 18 let.
Hodnota false se vrací pro uživatele, kteří nemají nastavené datum narození nebo je datum narození neověřené nebo nedosáhli zletilosti.
Předání informace o zletilosti není pro uživatele volitelné, je proto vhodné, abyste scope využili jen v případě, že je pro vás tato informace vzhledem k vaší činnosti nezbytná.

birthday

Přidáním hodnoty birthday po uživateli vyžadujeme jeho datum narození. V odpovědi na /api/v1/user pak přibude:

birthday – datum narození ve formátu ISO 8601 (jen pokud uživatel datum zadal, jinak null)

gender

Přidáním hodnoty gender po uživateli vyžadujeme informaci o jeho pohlaví. V odpovědi na /api/v1/user pak přibude:

gender – pohlaví jako jeden z řetězců "Male" / "Female" / "Other" (pokud není známo, pak null)

socialmodules

Tento scope od uživatele nevyžaduje žádný další souhlas. Jeho jediným účelem je v odpovědi na /api/v1/oauth/token získat:

social_token – krátkodobě platné tajemství, které lze předat jako zdroj autorizace do použitého sociálního embedu. Pozor: toto tajemství má stejnou platnost, jako vrácený access_token, a proto je nutné časem provádět jeho obnovení (viz kapitolu Obnovení tokenu).

calendar

Token obsahující tento scope lze následně vložit do hlavičky Authorization při komunikaci protokolem CalDAV. Lze tak přistupovat ke kalendáři daného uživatele.

email

Token obsahující tento scope lze následně použít pro mechanismus XOAUTH2 při komunikaci protokolem IMAP. Lze tak přistupovat ke zprávám v e-mailové schránce daného uživatele.