Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thosakwe/instagram_dart
Dart Instagram client library.
https://github.com/thosakwe/instagram_dart
dart instagram instagram-api
Last synced: 3 months ago
JSON representation
Dart Instagram client library.
- Host: GitHub
- URL: https://github.com/thosakwe/instagram_dart
- Owner: thosakwe
- License: mit
- Archived: true
- Created: 2017-07-18T17:34:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-12T17:15:48.000Z (over 5 years ago)
- Last Synced: 2024-09-25T19:19:55.890Z (3 months ago)
- Topics: dart, instagram, instagram-api
- Language: Dart
- Homepage: https://pub.dartlang.org/packages/instagram
- Size: 40 KB
- Stars: 6
- Watchers: 5
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ARCHIVED
See the reasons here: https://github.com/thosakwe/instagram_dart/issues/8
# instagram
[](https://pub.dartlang.org/packages/instagram)
### NOTE: The old Instagram API is now deprecated; this package will now focus on the Instagram Graph API.
Dart Instagram client library. This library includes support for authentication,
as well as all of the Instagram API v1 endpoints.
The API is entirely documented, for convenience. :+1:
Users of
[Angel](https://angel-dart.github.io)
can use
[`package:angel_auth_instagram`](https://pub.dartlang.org/packages/angel_auth_instagram)
to authenticate users with Instagram.
*Coming soon: Subscriptions*
* [Installation and Usage](#installation-and-usage)
* [Authentication](#authentication)
* [Via Access Token](#via-access-token)
* [`InstagramApiAuth`](#instagramapiauth)
* [Implicit Auth](#implicit-auth)
* [Explicit Auth](#explicit-auth)
* [Constants](#constants)
# Authentication
## Via Access Token
If you already have an access token, you can authenticate a client.
*Note: The `user` property of the `InstagramClient` will be `null`.*
```dart
var client = InstagramApiAuth.authorizeViaAccessToken('');
var me = await client.users.self.get();
```
## InstagramApiAuth
To perform authentication, use the `InstagramApiAuth` class. All API scopes are
included as `InstagramApiScope` constants for convenience.
```dart
var auth = new InstagramApiAuth('', '',
redirectUri: Uri.parse(''),
scopes: [
InstagramApiScope.basic,
InstagramApiScope.publicContent,
// ...
]
);
```
## Implicit Auth
Applications with no server-side component can implement
[implicit auth](https://www.instagram.com/developer/authentication/).
To get a redirect URI:
```dart
var redirectUri = auth.getImplicitRedirectUri();
window.location.href = redirectUri.toString();
```
## Explicit Auth
This library also supports traditional OAuth2 authentication.
To obtain a redirect URI:
```dart
var redirectUri = auth.getRedirectUri();
var redirectUri = auth.getRedirectUri(state: 'foo.bar=baz');
res.redirect(redirectUri.toString());
```
After you have obtained an authorization code, you can exchange it for an access token,
and receive an `InstagramClient`.
This example is an
[Angel](https://angel-dart.github.io)
handler:
```dart
app.get('/auth/instagram/callback', (RequestContext req, InstagramApiAuth instaAuth) async {
var client = await instaAuth.handleAuthorizationCode(req.query['code'], new http.Client());
var me = await client.users.self.get();
// Do something with the authenticated user...
});
```
You can also manage
[subscriptions](https://www.instagram.com/developer/subscriptions):
```dart
main() {
var subscriptions = instaAuth.createSubscriptionManager(new http.Client());
}
```
# Endpoints
The `InstagramClient` contains several getters that correspond to endpoints. Each is an abstraction over
a specific Instagram API.
Here is an example with the `relationships` API:
```dart
Future userFollowsMe(String userId, InstagramClient instagram) async {
var relationship = await instagram.relationships.toUser(userId).get();
return relationship.incomingStatus == IncomingStatus.followedBy;
}
```
# Constants
This API includes several classes containing helpful constants:
* `InstagramApiScope`
* `IncomingStatus`
* `OutgoingStatus`
* `RelationshipAction`
* `MediaType`
* `SubscriptionObject`
* `SubscriptionAspect`