PinSharp
PinSharp copied to clipboard
.NET client for working with the Pinterest API.
PinSharp
An async C# wrapper library for the Pinterest API.
- https://developers.pinterest.com/docs/getting-started/introduction/
Notice
I'm not maintaining this regularly as I don't use it that much. If you have any issues or request please create a new issue and I'll have a look.
Overview
-
New in version 2.0
- Breaking changes
- Examples
New in version 2.0
A lot of the changes are code cleanup and refactoring, but there is a few new features.
Rate limit information
Information about rate limits are now stored on the PinSharpClient
in the property RateLimits
It contains information about the request limit and remaining requests and when this information was last updated (i.e. the time of your last request through this client).
Exceptions
The client now throws its own exceptions all extending from PinSharpException
.
For example a PinSharpRateLimitExceededException
will be thrown if the rate limit has been exceeded.
Breaking changes in version 2.0
All return types have generally been changed from a concrete class to an interface, e.g. Pin
to IPin
.
BoardDetails
and UserDetails
have also been renamed in the process to IDetailedBoard
and IDetailedUsers
.
Renamed
-
PinterestClient
renamed toPinSharpClient
-
PinterestAuthClient
renamed toPinSharpAuthClient
-
PinterestApi
madeinternal
-
Scopes.WriteRelationShips
renamed toScopes.WriteRelationsships
Moved
-
PinSharp.IHttpClient
moved toPinSharp.Http.IHttpClient
-
PinSharp.Models.ImageInfo
moved toPinSharp.Models.Images.ImageInfo
Refactored/combined
- Models
-
BoardDetails
removed - merged intoBoard
and exposed asIDetaildBoard
interface -
UserDetails
removed - merged intoUser
and exposed asIDetailedUser
interface -
UserBoard
removed - merged intoBoard
and exposed asIUserBoard
interface -
UserPin
removed - merged intoPin
and exposed asIUserPin
interface
-
- Counts
-
BoardCounts
removed - merged into newCounts
and exposed asIBoardCounts
interface -
PinCounts
removed - merged into newCounts
and exposed asIPinCounts
interface -
UserCounts
removed - merged into newCounts
and exposed asIUserCounts
interface
-
- Images
-
BoardImages
removed - merged into newImageList
and exposed asIBoardImageList
interface -
PinImages
removed - merged into newImageList
and exposed asIPinImageList
interface -
UserImages
removed - merged into newImageList
and exposed asIUserImageList
interface
-
Examples
You need an access token to use the API.
If you don't have one already you can generate one here: https://developers.pinterest.com/tools/access_token/
// Create a client with your access token
var client = new PinSharpClient("AB_IBS7Q0fFQbXJ90JGtSDXNMV-tEBkfLftbK6JCpEWkGoA_MwAAAAA");
// Get board information
var board = await client.Boards.GetBoardAsync("machineshopcafe/best-of-mclaren-machine");
// Get pins on board
var pins = await client.Boards.GetPinsAsync("machineshopcafe/best-of-mclaren-machine");
// Get pins on board but only with the 'board' field as dynamic or your own type
var pins = await client.Boards.GetPinsAsync<dynamic>("rice_up/tableware", new[] { "board" });
// Get user info of the user associated with the access token
var user = await client.Me.GetUserAsync();
// Get pins of the user associated with the access token
var pins = await client.Me.GetPinsAsync();
// Get boards of the user associated with the access token
var boards = await client.Me.GetBoardsAsync();
// Search the associated user's pins or boards
var pins = await client.Me.SearchPinsAsync("mclaren");
var boards = await client.Me.SearchBoardsAsync("mclaren");
// Create new pin
var newPin = await client.Pins.CreatePinAsync("machineshopcafe/best-of-mclaren-machine", "http://i.imgur.com/abcdef.jpg", "Looks so cool!");
// Follow/unfollow board or user
await client.Me.FollowBoardAsync("machineshopcafe/best-of-mclaren-machine");
await client.Me.UnfollowBoardAsync("machineshopcafe/best-of-mclaren-machine");
await client.Me.FollowUserAsync("machineshopcafe");
await client.Me.UnfollowUserAsync("machineshopcafe");