Introduction

    API 사용 준비하기

    Airbridge는 API를 통해 광고 성과를 극대화 할 수 있는 환경을 제공합니다. Airbridge API는 REST의 형태로 구성되며 리소스 지향 URL을 가지고 있고, JSON 응답을 반환하며 표준 HTTP 응답 코드 및 인증을 사용합니다.

    기본 URL

    Airbridge API에 사용되는 기본 URL은 아래와 같은 형식입니다.

    모든 요청은 HTTPS를 통해서 이루어져야 합니다. 일반 HTTP 프로토콜을 사용한 호출, 인증이 없는 API 요청은 모두 오류를 반환합니다.

    1
    https://api.airbridge.io

    헤더

    Airbridge API에 대한 요청에는 다음 헤더가 포함됩니다.

    12
    Content-Type: application/json; charset=utf-8
    Authorization: Bearer {AIRBRIDGE-API-TOKEN}

    모든 요청은 기본적으로 Content-Type 헤더가 필요합니다.

    인증을 위한 토큰은 Authorization 헤더로 전송할 수 있습니다.

    인증

    Airbridge API는 API Key를 사용하여 인증을 요청합니다. Airbridge 대시보드 내 [Settings] > [Tokens] 에서 API 키를 보고 관리할 수 있습니다.

    세분화된 권한 제어를 위해 역할이 제한된 토큰이 존재합니다.

    API 토큰

    API 토큰은 모든 API 호출에 사용할 수 있습니다. 이 토큰은 접근할 수 있는 권한이 많으므로, 공개적으로 접근할 수 있는 영역에 API 토큰이 노출되지 않도록 주의해주시기 바랍니다.

    트래킹 링크 API 토큰

    트래킹 링크 API 토큰은 트래킹 링크의 생성을 위해 사용할 수 있는 API입니다. 클라이언트에서 트래킹 링크를 생성할 필요가 있을 경우 이 토큰을 이용할 수 있습니다.

    토큰 유출 또는 재생성 시 주의사항

    만약 토큰이 유출되었다면, [Settings]>[Tokens]에서 재생성할 수 있습니다. 이때, 기존 토큰은 자동으로 폐기되며 해당 토큰을 사용하고 있던 모든 API에서 인증 에러를 받게 됩니다. 토큰의 재생성은 신중하게 결정해주시기 바랍니다.

    Postman Collection

    Postman은 API 사용을 쉽게 할 수 있게 도와주는 API Client입니다. Airbridge와 연동을 쉽게 하기 위해서 Postman Collection을 제공합니다.

    Postman collection 사용하기

    Postman collection을 사용하기 위해 collection을 fork한 후 {{api_key}}의 값을 채웁니다.

    API token과 App Name를 Airbridge Dashboard에서 복사해서 Initial Value에 붙여넣습니다.

    이 페이지가 도움이 되었나요?

    추가, 수정하면 좋을 내용이 있나요?