Install gem in your ruby project
gem install instagram_api_clientor just add to it your Gemfile
gem 'instagram_api_client'
if you are on the Rails and run bundle
Before you start making the requests to instagram API provide the access_token using the configuration
wrapping. If you are going to use Subscriptions you should add client_id and client_secret.
InstagramApi.config do |config|
config.access_token = 'put your token here'
config.client_id = 'put your client ID here'
config.client_secret = 'put your client secret here'
endAs for now Instagram access token doesn't change or expire, so you can use this simple-to-use service to generate it http://services.chrisriversdesign.com/instagram-token/ I the nearest future the OAuth authorization for access token fetching will be implemented.
The main module of the gem is InstagramApi. It provides a series of methods, regarding each Instagram resource. They are:
Users, Media, Comments, Likes, Tags and Locations. So the Users resource methods can be accessed by InstagramApi.user
method, Tags by InstagramApi.tag and so on.
The main methods of each resource are show, index, create, destroy and search. The methods and API endpoints
correspondence is as follows
| Gem Action | API Endpoint |
|---|---|
| User Resource | |
| InstagramApi.user.show | GET /users/self |
| InstagramApi.user(user_id).show | GET /users/user_id |
| InstagramApi.user.recent_media | GET /users/self/media/recent |
| InstagramApi.user(user_id).recent_media | GET /users/user_id/media/recent |
| InstagramApi.user.liked_media | GET /users/self/media/liked |
| InstagramApi.user.search(search_query) | GET /users/search |
| Relationship Endpoints block | |
| InstagramApi.user.follows | GET /users/self/follows |
| InstagramApi.user.followed_by | GET /users/self/followed-by |
| InstagramApi.user.requested_by | GET /users/self/requested-by |
| InstagramApi.user.check_relationship(user_id) | GET /users/user_id/relathionship |
| InstagramApi.user.change_relationship(user_id) | POST /users/user_id/relathionship |
| Media Resource | |
| InstagramApi.media(media_id).show | GET /media/media_id |
| InstagramApi.media.short_code(short_code) | GET /media/shortcode/shortcode |
| InstagramApi.media.search(search_query) | GET /media/search |
| Likes Endpoints block | |
| InstagramApi.media(media_id).likes | GET /media/media_id/likes |
| InstagramApi.media(media_id).add_like | POST /media/media_id/likes |
| InstagramApi.media(media_id).delete_like | DELETE /media/media_id/likes |
| Comment Endpoints block | |
| InstagramApi.media(media_id).comments | GET /media/media_id/comments |
| InstagramApi.media(media_id).add_comment | POST /media/media_id/comments |
| InstagramApi.media(media_id).delete_comment(comment_id) | DELETE /media/media_id/comments/comment_id |
| Tag Resource | |
| InstagramApi.tag(tag_name).show | GET /tags/tag_name |
| InstagramApi.tag(tag_name).recent_media | GET /tags/tag_name/media/recent |
| InstagramApi.tag.search(search_query) | GET /tags/search |
| Location Resource | |
| InstagramApi.location(location_id).show | GET /locations/location_id |
| InstagramApi.location(location_id).recent_media | GET /locations/location_id/media/recent |
| InstagramApi.location.search(search_query) | GET /locations/search |
Each method from the list above accepts a hash as a second argument with additional params according to official instagram developers documentation i.e.
InstagramApi.user.search('mell', {count: 10})
InstagramApi.user('my_user_id').recent_media({min_id: '22721881'})Search method can get either a query string or a hash. It depends on API requirements, i.e.
InstagramApi.user.search('mell')
InstagramApi.location.search({lat: 33.10, lng: 15.40})Response is a Hashie::Mash object
Subscriptions is a useful feature which allows to receive notifications when people who authenticated your app post new media on Instagram. You can find more information on https://www.instagram.com/developer/subscriptions/
Creating subscription is very simple. Just refer to the original documentation to check the options available
InstagramApi.subscription.create({
object: 'user',
aspect: 'media',
callback_url: 'http://your.callback/url'
})This method automatically generates verify_token. However, you can pass your own, if you prefer
InstagramApi.subscription.create({
object: 'user',
aspect: 'media',
callback_url: 'http://your.callback/url',
verify_token: 'MyCustomVerifyToken'
})When you add a subscription, Instagram will send a GET request to your callback URL to verify the existence of the URL.
When Instagram has new data, it'll POST this data to your callback URL. To validate the subscription your callback action
should validate verify_token from instagram request and response with a hub.challenge parameter value.
You can easily implement it with a single line
# CallbackController
# GET callback url action
def index
render plain: InstagramApi.subscription.validate(params)
endor
# CallbackController
# GET callback url action
def index
render plain: InstagramApi.subscription.validate(params, 'MyCustomVerifyToken')
endif you are using your own verify_token
You can easily get the list of your subscriptions
InstagramApi.subscription.indexor destroy them if you prefer
InstagramApi.subscription.destroy({object: 'all'})
InstagramApi.subscription.destroy({id: 1})- OAuth authorization for access token fetching
- Incode Documentation
- Cover functionality with tests
Problems? Check the Issues block to find the solution or create an new issue that we will fix asap. Feel free to contribute. This project is intended to be a safe, welcoming space for collaboration.
This gem is open-sourced by Agilie Team (info@agilie.com)
If you have any questions, suggestions or just need a help with web or mobile development, please email us at web@agilie.com. You can ask us anything from basic to complex questions.
We will continue publishing new open-source projects. Stay with us, more updates will follow!
The gem is available as open source under the MIT License (MIT) Copyright © 2017 Agilie Team