bitly
1.0.0
버전 4 비트 API를 사용하여 링크를 단축하고, 짧은 링크를 확장하고, 사용자, 링크 및 조직의 메트릭을보기위한 루비 보석.
설치
용법
입증
API 클라이언트 생성
링크를 단축하십시오
링크를 확장하십시오
사용 가능한 API 엔드 포인트
여러 떼
조직
사용자
비트 링크
사용자 정의 비트 링크
캠페인
BSD (브랜드 짧은 도메인)
Webhooks
HTTP 요청을 사용자 정의합니다
자신의 어댑터를 구축하십시오
개발
기여
특허
행동 강령
이 라인을 응용 프로그램의 보석에 추가하십시오.
보석 'BITTY'
그런 다음 실행 :
$ 묶음 설치
또는 직접 설치하십시오.
$ gem은 비교적으로 설치합니다
빠른 소개를 위해 Ruby에서 Bitly API를 사용하는 방법에 대한이 블로그 게시물을 읽으십시오.
모든 API 엔드 포인트에는 OAUTH 토큰을 사용한 인증이 필요합니다. Bitly Console에서 자신의 Oauth 토큰을 얻을 수 있습니다. 계정 드롭 다운 메뉴를 클릭 한 다음 프로필 설정을 클릭 한 다음 일반 액세스 토큰을 클릭하십시오. 비밀번호를 입력하면 OAUTH 액세스 토큰을 생성 할 수 있습니다.
OAUTH 흐름을 통해 사용자를위한 액세스 토큰을 생성하는 다른 방법은 인증 문서를 참조하십시오.
액세스 토큰이 있으면 모든 API 메소드를 사용할 수 있습니다.
모든 API 메소드는 Bitly::API::Client 통해 사용할 수 있습니다. 액세스 토큰으로 클라이언트를 초기화하십시오.
client = bitly :: api :: client.new (Token : Token)
그런 다음 클라이언트를 사용하여 API로 작업을 수행 할 수 있습니다.
인증 된 클라이언트를 사용하면 다음과 같은 링크를 단축 할 수 있습니다.
bitlink = client.shorten (long_url : "http://example.com") bitlink.link# => http://bit.ly/2oujim0
승인 된 상태에서는 비트 링크를 확장 할 수 있습니다.
bitlink = client.expand (bitlink : "bit.ly/2oujim0")bitlink.long_url# => http://example.com
이 GEM은 TheBrity API에 대한 다음의 활성 V4 API 엔드 포인트를 지원합니다.
그룹 문서
그룹 검색 ( GET /v4/groups )
검색 그룹 ( GET /v4/groups/{group_guid} )
업데이트 그룹 ( PATCH /v4/groups/{group_guid} )
그룹별로 태그 검색 ( GET /v4/groups/{group_guid}/tags )
그룹 선호도 검색 ( GET /v4/groups/{group_guid}/preferences 설정)
업데이트 그룹 환경 설정 ( PATCH /v4/groups/{group_guid}/preferences )
그룹별 비트 링크 검색 ( GET /v4/groups/{group_guid}/bitlinks )
그룹별로 정렬 된 비트 링크를 검색합니다 ( GET /v4/groups/{group_guid}/bitlinks/{sort} )
그룹 단축 카운트 검색 ( GET /v4/groups/{group_guid}/shorten_counts )
GET /v4/groups/{group_guid}/referring_networks
국가 별 그룹의 클릭 메트릭 검색 ( GET /v4/groups/{group_guid}/countries )
[프리미엄] 도시 별 그룹의 클릭 메트릭 검색 ( GET /v4/groups/{group_guid}/cities )
[프리미엄] Get Group Ownrides ( GET /v4/groups/{group_guid}/overrides )
조직 문서
조직 검색 ( GET /v4/organizations )
조직 검색 ( GET /v4/organizations/{organization_guid} )
조직 단축 카운트 검색 ( GET /v4/organizations/{organization_guid}/shorten_counts )
사용자 문서
사용자 검색 ( GET /v4/user )
사용자 업데이트 ( PATCH /v4/user )
비트 링크 문서
링크 단축 ( POST /v4/shorten )
비트 링크 확장 ( POST /v4/expand )
비트 링크 검색 ( GET /v4/bitlinks/{bitlink} )
비트 링크 생성 ( POST /v4/bitlinks )
비트 링크 업데이트 ( PATCH /v4/bitlinks/{bitlink} )
편집되지 않은 해시 비트 링크 삭제 ( DELETE /v4/bitlinks/{bitlink} )
비트 링크에 대한 클릭을 가져옵니다 ( GET /v4/bitlinks/{bitlink}/clicks )
비트 링크에 대한 클릭 요약 가져 오기 ( GET /v4/bitlinks/{bitlink}/clicks/summary )
국가 별 비트 링크에 대한 메트릭 얻기 ( GET /v4/bitlinks/{bitlink}/countries )
추천자 별 비트 링크에 대한 메트릭을 가져옵니다 ( GET /v4/bitlinks/{bitlink}/referrers )
도메인을 참조하여 비트 링크에 대한 메트릭을 가져옵니다 ( GET /v4/bitlinks/{bitlink}/referring_domains )
도메인별로 ( GET /v4/bitlinks/{bitlink}/referrers_by_domains ) 별 비트 링크에 대한 메트릭을 가져옵니다.
[프리미엄] 도시 별 비트 링크에 대한 메트릭을 얻습니다 ( GET /v4/bitlinks/{bitlink}/cities )
[프리미엄] 장치 유형별 비트 링크에 대한 메트릭을 얻습니다 ( GET /v4/bitlinks/{bitlink}/devices )
[프리미엄] 비트 링크에 대한 QR 코드 검색 ( GET /v4/bitlinks/{bitlink}/qr )
[프리미엄] QR 코드 업데이트 ( PATCH /v4/bitlinks/{bitlink}/qr )
[프리미엄] QR 코드 생성 ( POST /v4/bitlinks/{bitlink}/qr )
사용자 정의 비트 링크 추가 ( POST /v4/custom_bitlinks )
[프리미엄] 사용자 정의 비트 링크 검색 ( GET /v4/custom_bitlinks/{custom_bitlink} )
[프리미엄] 업데이트 사용자 정의 비트 링크 ( PATCH /v4/custom_bitlinks/{custom_bitlink} )
[Premium] 대상 별 사용자 정의 비트 링크에 대한 메트릭 얻기 ( GET /v4/custom_bitlinks/{custom_bitlink}/clicks_by_destination )
[Premium] 사용자 정의 Bitlin의 전체 기록을 클릭하십시오 ( GET /v4/custom_bitlinks/{custom_bitlink}/clicks )
[프리미엄] 캠페인 검색 ( GET /v4/campaigns )
[프리미엄] 캠페인 생성 ( POST /v4/campaigns )
[프리미엄] 검색 캠페인 ( GET /v4/campaigns/{campaign_guid} )
[Premium] 업데이트 캠페인 ( PATCH /v4/campaigns/{campaign_guid} )
[프리미엄] 채널 검색 ( GET /v4/channels )
[프리미엄] 채널 생성 ( POST /v4/channels )
[프리미엄] 채널 검색 ( GET /v4/channels/{channel_guid} )
[Premium] 업데이트 채널 ( PATCH /v4/channels/{channel_guid} )
브랜드 짧은 도메인 문서
BSD 검색 ( GET /v4/bsds )
[Premium] Get WebHooks ( GET /v4/organizations/{organization_guid}/webhooks )
[Premium] Webhook 만들기 ( POST /v4/webhooks )
[프리미엄] 웹 후크 검색 ( GET /v4/webhooks/{webhook_guid} )
[Premium] Webhook 업데이트 ( POST /v4/webhooks/{webhook_guid )
[프리미엄] webhook 삭제 ( DELETE /v4/webhooks/{webhook_guid} )
[프리미엄] Webhook POST /v4/webhooks/{webhook_guid}/verify
이 보석에는 다른 어댑터를 사용할 수있는 HTTP 클라이언트가 제공됩니다. 기본적으로 사용하는 Net::HTTP 어댑터와 함께 제공됩니다.
연결을 제어하려면 Net::HTTP 어댑터 인스턴스를 작성하고 HTTP 프록시 또는 요청을 제어하는 옵션에 대한 IT 옵션을 전달할 수 있습니다. 예를 들어, read_timeout 제어하려면 다음을 수행 할 수 있습니다.
어댑터 = bitly :: http :: 어댑터 :: nethttp.new (request_options : {read_timeout : 1}) http_client = bitly :: http :: client.new (어댑터) api_client = bitly :: api :: client.new (http : http_client, 토큰 : 토큰)마찬가지로 프록시 변수를 어댑터 생성자로 전달하여 어댑터와 함께 HTTP 프록시를 사용할 수 있습니다.
어댑터 = bitly :: http :: 어댑터 :: nethttp.new (proxy_addr : "example.com", proxy_port : 80, proxy_user : "username", proxy_pass : "password") http_client = bitly :: http :: client.new (어댑터) api_client = bitly :: api :: client.new (http : http_client, token : token)
요청을 더 많이 제어하려면 고유 한 어댑터를 구축 할 수 있습니다. 이 보석 내의 HTTP 어댑터에는 약간의 request 인스턴스 메소드가 있어야합니다 Bitly::HTTP::Request
응답 상태 코드
문자열로 응답의 본문
응답 헤더는 해시입니다
응답이 성공했는지 여부를 나타내는 부울
예를 들어 ./src/bitly/http/adapters/net_http.rb 참조하십시오.
레포를 확인한 후 bin/setup 실행하여 종속성을 설치하십시오. 그런 다음 rake spec 실행하여 테스트를 실행하십시오. 실험 할 수있는 대화식 프롬프트를 위해 bin/console 실행할 수도 있습니다.
이 보석을 로컬 컴퓨터에 설치하려면 bundle exec rake install 실행하십시오. 새 버전을 해제하려면 version.rb 에서 버전 번호를 업데이트 한 다음 버전에 대한 bundle exec rake release 태그를 생성하고 GIT 커밋 및 태그를 누르고 .gem 파일을 rubygems.org로 누릅니다.
https://github.com/philnash/bitly에서 Github에서 버그 보고서 및 풀 요청을 환영합니다. 이 프로젝트는 협력을위한 안전하고 환영하는 공간이되기위한 것이며, 기고자들은 기고자 계약 규범을 준수 할 것으로 예상됩니다.
보석은 MIT 라이센스의 조건에 따라 오픈 소스로 제공됩니다.
Bitly Project의 코드베이스, 이슈 추적기, 대화방 및 메일 링리스트에서 상호 작용하는 모든 사람은 행동 강령을 따라야합니다.
