API 이용안내

  1. Casa
  2. API 이용안내
PHP에서의 API사용

 

시스템에서 처리할 요청을 처리하려면 API키가 필요합니다. 사용자가 등록하면 이 사용자에 대해 API키가 자동으로 생성됩니다. API키는 각 요청과 함께 키 파라미터를 통해 전송되어야 합니다.(아래의 전체 예제 참조)

API키가 전송되지 않았거나 만료된 경우 오류가 발생합니다.

※ 회원님의 API는 절대 외부에 유출하시면 안됩니다. 유출로 인해 문제 발생시 이용에 제한이 될 수 있으니 주의하시기 바랍니다.

API키는 로그인 후 '프로필설정'에서 확인 가능합니다.

 

 

URL단축을 위한 요청 전송

요청을 전송하기 위해 사용자는 변수 api와 url이 필요한 다음 형식을 사용해야 합니다. 아래의 예에서는 데모 URL이 사용되지만 사용자 고유의 도메인 이름을 사용해야 합니다. 사용자 지정 별칭을 요청하려면 끝에 &custom= 를 추가하면 됩니다.

GET https://vo.la/api/?key=API키&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS

 

 

서버 응답

서버 응답은 JSON형식(기본 값)으로 인코딩됩니다. 이는 모국어 간 사용을 촉진하기 위해 수행됩니다. 응답의 첫번째 요소는 항상 오류가 발생했는지(오류:1)여부를 알려줍니다(오류:0). 두번째 요소는 첫번째 요소와 관련하여 변경됩니다. 오류가 발생하면 두번째 요소의 이름이 'msg'가 됩니다. 이는 오류의 원인을 포함하고 있으며, 그렇지 않으면 짧은 URL을 포함하는 'short'로 지정됩니다.

 

오류 없음

{"error":0,"short":"https:\/\/vo.la\/DkZOb"}

오류가 발생했습니다

{"error":1,"msg":"Please enter a valid url" }

 

일반 텍스트 형식 사용

요청이 끝날 때 & format = text를 추가하여 일반 텍스트로 응답을 요청할 수 있습니다. 오류가 발생하면 아무 것도 출력하지 않으므로 비어있는 경우 오류가 발생할 수 있습니다.

 

 

PHP에서 API 사용하기

PHP 응용 프로그램에서 API를 사용하려면 file_get_contents 또는 cURL을 통해 GET 요청을 보내야합니다. 아래 예시된 함수를 참고해 사용 할 수 있습니다.

<?php/**** Sample PHP Function ***/function shorten($url, $custom = "", $format = "json") { $api_url = "https://vo.la/api/?key=API키";$api_url .= "&url=".urlencode(filter_var($url, FILTER_SANITIZE_URL));if(!empty($custom)){$api_url .= "&custom=".strip_tags($custom);}$curl = curl_init();curl_setopt_array($curl, array(CURLOPT_RETURNTRANSFER => 1,CURLOPT_URL => $api_url));$Response = curl_exec($curl);curl_close($curl);if($format == "text"){$Ar = json_decode($Response,TRUE);if($Ar["error"]){return $Ar["msg"];}else{return $Ar["short"];}}else{return $Response;}}?>

 

간단한 사용법
<?phpecho shorten("https://google.com");?>

 

사용자 정의 별칭 사용
<?phpecho shorten("https://google.com", "google");?>

 

사용자 정의 별칭 및 텍스트 형식 사용
<?phpecho shorten("https://google.com", "google", "text");?>

 

로그인 후, 더 많은 기능 확인이 가능합니다.

통계확인 및 삭제 기능은 로그인 후 대시보드 '개발용 API' 메뉴에서 자세한 내용을 확인하실 수 있습니다.