Depuis le swagger (rajouter /swagger-ui/
à votre URL d'API), vous pouvez renseigner votre clé d'API en cliquant sur le bouton "Authorize" en haut à droite.
Pour utiliser l'API dans votre développement, il est nécessaire de passer votre clé d'API avec le header X-Api-Key
pour chacune de vos requêtes.
Votre URL d'appel sera composée de l'URL de l'API (exemple https://demo.web-connect.api.yodaforex.fr
)+ celle du End Point voulu (exemple /v1/sync/fixings
).
Exemple en PHP avec cURL
function requestYfxWebConnect( $url, $key, $json = true, $data = array(), $type = 'GET' ) { $curl = curl_init(); curl_setopt_array( $curl, array( CURLOPT_URL => $url, CURLOPT_RETURNTRANSFER => true, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_CUSTOMREQUEST => $type, CURLOPT_HTTPHEADER => array( "X-Api-Key: " . $key . "", "content-type: application/json", "accept: application/json" ), CURLOPT_POSTFIELDS => ( !empty( $data ) ) ? json_encode( $data ) : null, ) ); $response = curl_exec( $curl ); $err = curl_error( $curl ); curl_close( $curl ); if ( $err ) { echo "cURL Error #:" . $err; return false; } else { return json_decode( $response, true ); } }
Exemple en ajax
La connexion en ajax fonctionne uniquement pour les clés ajax, et uniquement pour la consultation des produits.
Soyez conscient que la clé Ajax sera accessible à tous, et que n'importe qui pourra donc accéder à vos produits de la base Web Connect via l'API.
function main() { let xhr = new XMLHttpRequest(); xhr.open('GET', 'https://demo.web-connect.api.yodaforex.fr/ajax/v1/fixings/metal/gold'); xhr.setRequestHeader("X-API-Key", "xxxxxx"); xhr.onload = function() { if (xhr.status !== 200) { alert(`Error ${xhr.status}: ${xhr.statusText}`); } else { // show the result document.getElementsByTagName("body")[0].innerText = `Résultat de la requête AJAX : ${xhr.response}` } }; xhr.onprogress = function(event) { if (event.lengthComputable) { console.log(`Received ${event.loaded} of ${event.total} bytes`); } else { console.log(`Received ${event.loaded} bytes`); // no Content-Length } }; xhr.onerror = function() { alert("Request failed"); }; xhr.send(); }
Commentaires
0 commentaire
Vous devez vous connecter pour laisser un commentaire.