Preklady

Prostredníctvom služby Swiftyper Internationalization API je možné vyhľadať a preložiť uložené natívne frázy vašej aplikácie ktoré boli vygenerované cez knižnicu fbt.

Definícia modelu frázy

Atribúty

Name
id
Type
integer
Description
Unikátny identifikátor frázy.
Name
parent_id
Type
integer
Description
Rodičovský identifikátor frázy.
Name
object
Type
string
Description
Typ objektu, vždy bude phrase.
Name
hash
Type
array
Description
Hash pozostávajúci z textu a popisu.
Name
text
Type
string
Description
Natívna fráza.
Name
description
Type
string
Description
Popis frázy bližšie uvádzajúci jej kontext.
Name
author
Type
string
Description
Meno autora frázy.
Name
project
Type
string
Description
Názov projektu pre ktorý je fráza určená.
Name
created_at
Type
string
Description
Dátum vytvorenia frázy.

POST/v1/intl/phrases/query

Vyhľadanie fráz

Vyhľadanie natívnych fráz. Pokiaľ nepoužijete vyhľadávanie, výstupom budú všetky frázy.

Povinné parametre

Name
api_key
Type
string
Description
Prístupový API kľúč môžete použiť ako parameter api_key alebo v hlavičke požiadavky X-Swiftyper-API-Key.

Parametre

Name
query
Type
string
Description
Výraz vyhľadávania.

Výstup

Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču.

Požiadavka

curl -X POST https://api.swiftyper.sk/v1/intl/phrases/query \
   -H 'X-Swiftyper-API-Key: VÁŠ_API_KĽÚČ' \
   -d query=Re-type

Odpoveď

[
    {
        "id": 6523,
        "parent_id": null,
        "object": "phrase",
        "source": {
            "type": "text",
            "jsfbt": "Re-type new"
        },
        "hash": "18bbb08b9f909c7930272edacc121b68",
        "text": "Re-type new",
        "description": "Label: input for a re-typing of new password",
        "author": "richard",
        "project": "Super Secret",
        "created_at": "2019-05-15 00:04:47"
    }
]

POST/v1/intl/phrases/upload

Uloženie fráz

Uloženie natívnych fráz v anglickom jazyku do databázy aby sa dali preložiť. Ďalšie informácie o prekladoch nájdete v časti Preklady.

Povinné parametre

Name
native_strings
Type
string
Description
Množina objektov kódovaná v JSON formáte.
Name
api_key
Type
string
Description
Prístupový API kľúč môžete použiť ako parameter api_key alebo v hlavičke požiadavky X-Swiftyper-API-Key.

Výstup

Výstupom je informácia o počte úspešne uložených frázach. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču.

Požiadavka

curl -X POST https://api.swiftyper.sk/v1/intl/phrases/upload \
   -H 'X-Swiftyper-API-Key: VÁŠ_API_KĽÚČ' \
   -d native_strings=[{"hashToText": {"1fd896e07ee91d9f4d6e0f05d0b93bcf": "A simple string"},"desc": "It's simple","project": "website app","author": "M@rty","type": "text","jsfbt": "A simple string"}]

Odpoveď

{
    "inserted": 1
}

Definícia modelu prekladu

Atribúty

Name
id
Type
integer
Description
Unikátny identifikátor prekladu.
Name
phrase_id
Type
integer
Description
Identifikátor zdrojovej frázy.
Name
object
Type
string
Description
Typ objektu, vždy bude translation.
Name
phrase_hash
Type
string
Description
Hash identifikátor zdrojovej frázy.
Name
hash
Type
string
Description
Hash prekladu.
Name
translation
Type
string
Description
Preklad.
Name
approval_status
Type
string
Description
Stav prekladu.
Name
variations
Type
integer[]
Description
Varianty tokenov.
Name
tokens
Type
integer[]
Description
Tokeny.
Name
types
Type
integer[]
Description
Druh tokenu (číslo/pohlavie).
Name
locale
Type
string
Description
Jazyk prekladu.
Name
created_at
Type
string
Description
Dátum preloženia.

POST/v1/intl/translations/query

Vyhľadanie prekladov

Vyhľadanie a načítanie prekladov. Pokiaľ nepoužijete vyhľadávanie, výstupom budú iba preklady ktoré boli schválené automaticky (podľa počtu hlasov), alebo manuálne.

Povinné parametre

Name
api_key
Type
string
Description
Prístupový API kľúč môžete použiť ako parameter api_key alebo v hlavičke požiadavky X-Swiftyper-API-Key.

Parametre

Name
query
Type
string
Description
Výraz vyhľadávania.

Výstup

Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču.

Požiadavka

curl -X POST https://api.swiftyper.sk/v1/intl/translations/query \
   -H 'X-Swiftyper-API-Key: VÁŠ_API_KĽÚČ' \
   -d query=Heslo

Odpoveď

[
    {
        "id": 7325,
        "phrase_id": 6523,
        "object": "translation",
        "phrase_hash": "18bbb08b9f909c7930272edacc121b68",
        "hash": "18bbb08b9f909c7930272edacc121b68",
        "translation": "Zopakujte heslo",
        "approval_status": "approved",
        "variations": [],
        "tokens": [],
        "types": [],
        "locale": "sk_SK",
        "created_at": "2019-05-15 22:22:01"
    }
]

POST/v1/intl/translation/submit

Uloženie prekladu

Uloženie prekladu frázy do vybraného jazyka.

Povinné parametre

Name
translation
Type
string
Description
Preklad frázy.
Name
hash
Type
string
Description
Hash prekladanej frázy.
Name
locale
Type
string
Description
Jazyk prekladu.
Name
contributor
Type
string
Description
E-mailová adresa člena organizácie (prekladateľ, správca).
Name
api_key
Type
string
Description
Prístupový API kľúč môžete použiť ako parameter api_key alebo v hlavičke požiadavky X-Swiftyper-API-Key.

Výstup

Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču.

Požiadavka

curl -X POST https://api.swiftyper.sk/v1/intl/translation/submit \
   -H 'X-Swiftyper-API-Key: VÁŠ_API_KĽÚČ' \
   -d translation=Zopakujte heslo \
   -d hash=18bbb08b9f909c7930272edacc121b68 \
   -d phash=18bbb08b9f909c7930272edacc121b68 \
   -d locale=sk_SK

Odpoveď

{
    "id": 7325,
    "phrase_id": 6523,
    "object": "translation",
    "phrase_hash": "18bbb08b9f909c7930272edacc121b68",
    "hash": "18bbb08b9f909c7930272edacc121b68",
    "translation": "Zopakujte heslo",
    "approval_status": "approved",
    "variations": [],
    "tokens": [],
    "types": [],
    "locale": "sk_SK",
    "created_at": "2019-05-15 22:22:01"
}