Utilizarea API-urilor Transformation Advisor

IBM Cloud Transformation Advisor furnizează un set de API-uri REST standard.
API-urile sunt conforme cu specificaţia OpenAPI 3.0.

Ediţia BETA

API-urile furnizate nu sunt încă finalizate în totalitate şi pot suferi modificări. Transformation Advisor încă nu este compatibil cu versiunile mai vechi în ceea ce priveşte API-urile. Nu există nicio garanţie că ediţiile viitoare vor include suport pentru aceste API-uri. Vestea bună este că putem şi vom face modificările care vă sunt neceare. Nu trebuie decât să cereţi aceasta!

Documentaţia pentru API-uri

Documentaţia swagger pentru API-uri este disponibilă din instalarea dumneavoastră Transformation Advisor, la această locaţie: <TA_SERVER>/openapi/
Pentru aceste API-uri, poate fi găsită o interfaţă de utilizator interactivă la: <TA_SERVER>/openapi/ui/

Găsirea valorii TA_SERVER

Valoarea <TA_SERVER> poate fi găsită din OpenShift Cloud Platform folosind paşii următori:

1. Lansaţi OpenShift Cloud Platform Console UI.
2. Faceţi clic pe Home > Projects şi selectaţi proiectul pentru Transformation Advisor.
3. Faceţi clic pe Netwroking > Routes şi selectaţi 'openapi-route'.
4. Găsiţi Location, care conţine valoarea pentru <TA_SERVER>.

Limitările 'Try it out'

Când Transformation Advisor rulează în OpenShift Cloud Platform cu ingress activată, execuţia capabilităţii 'Try it out' va eşua. Aceasta se întâmplă deoarece lipseşte valoarea ingress pentru comanda curl generată. Puteţi să adăugaţi această valoare la comandă şi apoi să o rulaţi manual pentru a testa API-ul.

Găsirea valorii TA_SERVER cu Transformation Advisor Local

Procesul pentru găsirea valorii <TA_SERVER> este diferit dacă utilizaţi Transformation Advisor Local (disponibil aici).

1. Din locaţia în care rulaţi Transformation Advisor Local, lansaţi această comandă: docker ps
2. Căutaţi imaginea cu 'server' în nume şi verificaţi valoarea portului.
   • Valoarea implicită este 2220, ca în acest exemplu: 9443/tcp, 0.0.0.0:2220->9080/tcp
3. Deplasaţi-vă la acest URL: <TA_LOCAL_UI_URL>:<SERVER_PORT>/openapi/ui/

Jetonul de utilizator al API-ului

Pentru a accesa API-urile folosind propriul jeton de utilizator, finalizaţi următorii paşi:

1. Lansaţi OpenShift Cloud Platform Console UI.
2. Faceţi clic pe meniul derulant de utilizator în colţul din dreapta şi selectaţi 'Copy Login Command'.
3. Faceţi clic pe 'Display Token'.
4. Copiaţi valoarea atributului 'token'.
5. Introduceţi această valoare în câmpul apiKey din interfaţa de utilizator OpenAPI.

Crearea cheii de API

Pentru a accesa API-urile fără a vă baza pe un jeton de utilizator, finalizaţi următorii paşi pentru a crea un cont de serviciu şi a utiliza API-ul asociat cu contul respectiv.

1. Lansaţi OpenShift Cloud Platform Console UI.
2. Faceţi clic pe meniul derulant de utilizator în colţul din dreapta şi selectaţi 'Copy Login Command'.
3. Faceţi clic pe 'Display Token'.
4. Executaţi comanda Login.
5. Creaţi contul de serviciu, numit 'ta-api' în acest caz
   • oc create sa ta-api
6. Descrieţi contul de serviciu.
   • oc describe sa ta-api
7. Aceasta va lista un set de secrete Mountable. Descrieţi primul secret de jeton.
   • oc describe secret ta-api-secret-<TOKEN>
8. Copiaţi valoarea atributului 'token'.
9. Introduceţi această valoare în câmpul apiKey din interfaţa de utilizator OpenAPI.

Clientul REST de API

Pentru a simplifica integrarea API-urilor Transformation Advisor în produsul sau unealta dumneavoastră, este dezvoltat un client REST open-source, care va fi disponibil la o dată ulterioară.